StatusDesenvolvedoresParceirosPTENESEntrar
Falar com vendasCriar conta grátis
Criar conta grátis
Falar com vendasCriar conta grátis
EntrarStatusPTENES

Referência da API

Atributos de contato

Defina os atributos personalizados dos contatos da organização, com tipo e rótulo, e leia o dicionário que valida o campo attributes de cada contato.

  • 2 operações
  • URL basehttps://api.messages.ccxcompany.co
  • AutenticaçãoBearer com a sua chave de API

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

List the org's typed custom attribute definitions

GET/v2/organizations/me/custom-attribute-defs

Returns the dictionary that drives Contact.attributes validation. Returns { defs: [] } for orgs that haven't configured any.

Auth: contacts:read — every member that can read contacts also needs the schema to render the editor.

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    CampoTipoDescrição
    defsobrigatórioobject[]
    defs[].keyobrigatóriostring
    defs[].typeobrigatóriostringValores:stringnumberbooleandate
    defs[].labelopcionalstring
    defs[].requiredobrigatórioboolean
    JSON
    {  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": true    }  ]}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/organizations/me/custom-attribute-defs' \  -H "Authorization: Bearer $CCX_API_KEY"
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Replace the org's typed custom attribute definitions

PUT/v2/organizations/me/custom-attribute-defs

Full replace — caller passes { defs: [...] } matching the wire schema. Drop a key by omitting it.

Service rejects duplicate keys (CONFLICT) and arrays > 50 entries (VALIDATION_ERROR via Zod).

A definition that looks like a document, password, card or token (by key OR label) and still has values stored in contacts cannot be dropped nor relabeled: 409 with meta.code = PROPRIEDADE_SENSIVEL_EM_USO (clear the values first). If the check does not fit in 5 s, 503.

Corpo da requisiçãoapplication/json

CampoTipoDescrição
defsobrigatórioobject[]
defs[].keyobrigatóriostring
defs[].typeobrigatóriostringValores:stringnumberbooleandate
defs[].labelopcionalstring
defs[].requiredopcionalboolean
Exemplo completo do corpo
JSON
{  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": true    }  ]}

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    CampoTipoDescrição
    defsobrigatórioobject[]
    JSON
    {  "defs": [    {}  ]}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 409RFC 7807 problem details for CONFLICT (409).

  • 422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl -X PUT 'https://api.messages.ccxcompany.co/v2/organizations/me/custom-attribute-defs' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "defs": [      {        "key": "string",        "type": "string"      }    ]  }'
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Outras áreas da API

Travou em alguma rota? Fale com quem mantém a API.

Criar conta grátisFalar com vendas

Criando a conta pelo site, você ganha R$ 10 de crédito de teste.