Pular para o conteúdo

POST /v1/contacts/custom-fields/suggestion

POST
/v1/contacts/custom-fields/suggestion
curl --request POST \
--url https://seu-endereco-da-api/v1/contacts/custom-fields/suggestion \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "request": "example", "entity": "contact" }'

Permissão que a Chave de acesso precisa: Gerenciar campos personalizados (contacts:fields).

Media typeapplication/json
object
request
required
string
>= 1 characters <= 500 characters
entity
string
Allowed values: contact company deal conversation ticket
Media typeapplication/json
object
fields
required

Fields the AI proposes from the owner’s description; nothing is created until the owner confirms

Array<object>
object
key
required

Free key derived from the label, not taken by any field of the account, archived ones included

string
label
required
string
type
required
string
Allowed values: TEXT NUMBER DATE BOOLEAN SELECT MULTISELECT CPF_CNPJ MONEY PHONE EMAIL URL
options
required

Only for SELECT and MULTISELECT

Array<string>
description
required
string
nullable
groupId
required

Existing group of the same entity; null with groupName set means a group to create

string format: uuid
nullable
groupName
required
string
nullable
sensitive
required

Always false for deal fields

boolean
blocked
required

Why the AI was not asked; fields is empty when set

string
nullable
Allowed values: disabled daily_cap no_credit

Example

{
"fields": [
{
"type": "TEXT"
}
],
"blocked": "disabled"
}

The AI could not answer