Campos dos contatos

Listar os campos dos contatos

GET /v1/c/{slug}/contact-fields · Escopos: fields:read · contacts:read

Os campos da empresa (chave, nome nos três idiomas, tipo, opções). Os valores de cada contato vêm em fields do contato.

Parâmetros do endereço

Campo	Detalhes
`slug`	O identificador da empresa no DoneTalk (o mesmo da chave).

Exemplo de pedido

curl -X GET "https://api.donetalk.com/v1/c/demo/contact-fields" \
  -H "Authorization: Bearer $DONETALK_KEY"

Resposta 200

{
  "fields": [
    {
      "key": "cpf",
      "label": {
        "pt-BR": "CPF",
        "en": "CPF",
        "es": "CPF"
      },
      "type": "cpf",
      "options": null,
      "aiExtractable": true,
      "aiExtractionHint": null,
      "required": false,
      "sort": 1,
      "isActive": true
    }
  ]
}

Erros possíveis

401 unauthorized
403 insufficient_scope
422 validation_failed
429 rate_limited

Criar um campo

POST /v1/c/{slug}/contact-fields · Escopos: fields:write

Parâmetros do endereço

Campo	Detalhes
`slug`	O identificador da empresa no DoneTalk (o mesmo da chave).

Corpo do pedido

Campo	Tipo	Obrigatório	Detalhes
`key`	string	sim
`label`	string · object	sim
`type`	um de `text`, `number`, `date`, `boolean`, `select`, `phone`, `email`, `cpf`, `cnpj`	sim
`options`	lista de string	não	até 50; null
`aiExtractable`	boolean	não	default `false`
`aiExtractionHint`	string	não	até 300 caracteres; null
`required`	boolean	não	default `false`
`sort`	integer	não	até 1000

Exemplo de pedido

curl -X POST "https://api.donetalk.com/v1/c/demo/contact-fields" \
  -H "Authorization: Bearer $DONETALK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "plano",
  "label": "Plano",
  "type": "select",
  "options": [
    "mensal",
    "anual"
  ]
}'

Resposta 201

{
  "field": {
    "key": "cpf",
    "label": {
      "pt-BR": "CPF",
      "en": "CPF",
      "es": "CPF"
    },
    "type": "cpf",
    "options": null,
    "aiExtractable": true,
    "aiExtractionHint": null,
    "required": false,
    "sort": 1,
    "isActive": true
  }
}

Erros possíveis

401 unauthorized
403 insufficient_scope
422 validation_failed
429 rate_limited

Editar um campo

PATCH /v1/c/{slug}/contact-fields/{key} · Escopos: fields:write

Parâmetros do endereço

Campo	Detalhes
`slug`	O identificador da empresa no DoneTalk (o mesmo da chave).
`key`	A chave (do campo ou da ficha).

Corpo do pedido

Campo	Tipo	Obrigatório	Detalhes
`label`	string · object	não
`options`	lista de string	não	até 50; null
`aiExtractable`	boolean	não
`aiExtractionHint`	string	não	até 300 caracteres; null
`required`	boolean	não
`sort`	integer	não	até 1000
`isActive`	boolean	não

Exemplo de pedido

curl -X PATCH "https://api.donetalk.com/v1/c/demo/contact-fields/:key" \
  -H "Authorization: Bearer $DONETALK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "options": [
    "mensal",
    "semestral",
    "anual"
  ]
}'

Resposta 200

{
  "ok": true
}

Erros possíveis

401 unauthorized
403 insufficient_scope
422 validation_failed
429 rate_limited

Esta página em Markdown