Departamentos

URL base da API

https://crm.vdgestaobranding.com/api/v1

A documentação fica em developers.vdgestaobranding.com, mas todas as chamadas vão para crm.vdgestaobranding.com/api/v1.

GET/departments

settings:manage

Listar departamentos

curl -X GET "https://crm.vdgestaobranding.com/api/v1/departments" \
  -H "Authorization: Bearer $VDCRM_API_KEY"

Resposta 200

{
  "data": [
    {
      "id": "x1…",
      "name": "Suporte"
    }
  ]
}

POST/departments

settings:manage

Idempotency-Key

Criar

curl -X POST "https://crm.vdgestaobranding.com/api/v1/departments" \
  -H "Authorization: Bearer $VDCRM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Suporte"
}'

Resposta 201

{
  "id": "x1…",
  "name": "Suporte"
}

PATCH/departments/{id}

settings:manage

Atualizar

curl -X PATCH "https://crm.vdgestaobranding.com/api/v1/departments/{id}" \
  -H "Authorization: Bearer $VDCRM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Suporte"
}'

DELETE/departments/{id}

settings:manage

Excluir

curl -X DELETE "https://crm.vdgestaobranding.com/api/v1/departments/{id}" \
  -H "Authorization: Bearer $VDCRM_API_KEY"

POST/departments/{id}/members

settings:manage

Definir membros do departamento

Substitui a lista. Somente usuários com acesso a esta operação.

curl -X POST "https://crm.vdgestaobranding.com/api/v1/departments/{id}/members" \
  -H "Authorization: Bearer $VDCRM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "user_ids": [
    "u1…"
  ]
}'