Criar campo personalizado

Cria uma definição de campo personalizado para um objeto do CRM (negociação ou lead). A chave, o rótulo e o tipo são obrigatórios. Um campo de lead exige a escolha explícita de 'sensitive'; só campos de lead podem ser sensíveis (400 para outro objeto); um campo sensível exige 'legalBasis' (base legal da LGPD) e só é lido por quem pode ver dados sensíveis. 'optionTones' associa cada opção de um campo de seleção a um tom (chart-1 a chart-5 ou neutral). 'role' = classification marca o campo de classificação, no máximo um por objeto e sempre do tipo select. Responde 409 quando a chave ou o papel já existem no objeto. A chave de um campo sensível removido continua protegida: criar outro campo com ela, sensível ou não, pede leads:read_sensitive, porque os valores antigos continuam guardados nos leads. A permissão vem do objeto do campo: campos de lead pedem leads:read para ler e leads:configure para criar, editar e remover, e um campo sensível (antes ou depois da mudança) pede também leads:read_sensitive para ser criado, editado, desmarcado ou removido; campos de negociação seguem conversations:read, conversations:create, conversations:update e conversations:delete. Sem a permissão responde 403 (custom_field_forbidden).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Definição do campo a criar

string
string
string
string
enum
Allowed:
optionTones
object
options
array of strings
options
integer
boolean
string
enum
Allowed:
boolean
string
enum
Allowed:
Headers
string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json