Adicionar registro na empresa

Cria um registro em uma lista de dados e o vincula a uma empresa

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

Endpoint utilizado para adicionar um registro em uma lista de dados e vinculá-lo a uma empresa específica, informando o ID da empresa e o ID da lista de dados como path parameters.

Corpo da requisição

O corpo é um objeto JSON com:

  • order (inteiro de 0 a 9999, obrigatório): posição da linha na lista.
  • Uma propriedade por campo que você quer preencher. A chave é a key do campo, obtida em Ver detalhes da lista de dados; o valor é um objeto { "value": ... }.
Tipo do campo (datalist_field_type_id)Formato de value
1 NúmeroInteiro maior ou igual a 0
2 Número com vírgulaNumérico de 0 a 9999999999, ponto decimal. Aceita currency_id opcional ao lado de value
3 Data e hora"AAAA-MM-DD HH:MM:SS"
4 Data"AAAA-MM-DD"
5 Hora"HH:MM" ou "HH:MM:SS"
6 TextoAté 254 caracteres
7 Texto longoAté 65.535 caracteres
8 Única opçãoID da opção
9 Múltipla opçãoLista de IDs das opções

🚧

Atenção

Uma key que não existe na lista é ignorada sem erro: o registro é criado sem aquele valor. "value": null também é ignorado. Confira o data da resposta.

Erros

O 404 ocorre quando a empresa ou a lista não existem na conta, ou quando a lista pertence a outra entidade.

Valor fora do formato retorna 422 com a mensagem em data:

{
  "success": false,
  "message": "Unprocessable Entity",
  "data": {
    "value": ["O campo Valor do campo da lista de dados não corresponde ao formato Y-m-d."]
  }
}

Opção inexistente para o campo retorna 422 com message igual a Opção informada para o campo da lista de dados inválida.

📘

Leia antes

O passo a passo completo, com exemplos em curl, está em Registros por oportunidade, empresa ou pessoa.

Path Params
int32
required

ID da empresa.

int32
required

ID da lista de dados. A lista precisa ter entity igual a companies.

Body Params
json

{ "order": 1, "6d10783c2a2bd628d6ac0944757c9cf8": { "value": "2026-08-31" }, "a827b6e4df0535f21d6739624084a707": { "value": 125000 }, "e1c5ff25f5d853ff0d94079e50e06d73": { "value": 31 } }

Responses

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