PATCH /api/v1/organizations/:id

Atualiza as configurações de uma organização

Atualiza as configurações de uma organização. Apenas os campos enviados serão modificados (patch parcial).

​

Autenticação

Requer token de usuário (JWT) via header Authorization: Bearer. O usuário deve pertencer à organização.

​

Parâmetros de Path

id · string · required

ID da organização

​

Corpo da Requisição

Todos os campos são opcionais:

name · string

Nome da organização

bio · string

Biografia ou descrição da organização

company · string

Nome da empresa

blog · string

URL do blog

location · string

Localização

email · string

E-mail de contato público

twitter_username · string

Nome de usuário no Twitter/X

website · string

URL do site

avatar_url · string

URL do avatar

profile_settings · object

Configurações de perfil

feature_settings · object

Configurações de funcionalidades

subscription_settings · object

Configurações de assinaturas (ex: allow_multiple_subscriptions, proration_behavior)

notification_settings · object

Configurações de notificações (ex: new_sale, new_subscription)

socials · array

Links de redes sociais

details · object

Detalhes adicionais da organização (ex: about, product_description, intended_use, business_type).

​

Resposta

Retorna o objeto completo da organização atualizada.

​

Exemplo

cURL

curl -X PATCH "https://api.chargefy.io/api/v1/organizations/org_abc123" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Minha Empresa Ltda",
    "bio": "Soluções de pagamento para o Brasil",
    "email": "[e-mail]"
  }'

​

Resposta de Exemplo

{
  "id": "org_abc123",
  "name": "Minha Empresa Ltda",
  "slug": "minha-empresa",
  "avatar_url": "https://cdn.chargefy.io/avatars/org_abc123.png",
  "bio": "Soluções de pagamento para o Brasil",
  "email": "[e-mail]",
  "website": "https://minhaempresa.com.br",
  "status": "active",
  "created_at": "2025-06-01T08:00:00Z"
}