PEPINO ZAPdocs
Referência da APIDepartamentos

Cria um departamento

Ver como Markdown
POST
/v1/inbox/departments

Cria um departamento no Projeto. name e obrigatorio (max. 50 caracteres, unico no Projeto). description e opcional. Nome repetido retorna 409.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/inbox/departments" \  -H "Content-Type: application/json" \  -d '{    "name": "Financeiro",    "description": "Cobranca, boletos e notas fiscais"  }'
{
  "id": "string",
  "name": "string",
  "description": "string"
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "limite de numeros do plano atingido — adicione um numero em \"Meu plano\""
  }
}