Creates a record. Requires a read-write key with a responsible user; send Idempotency-Key so you can retry without duplicates. Creation fires the account's webhooks and automations, just like the screen.
Key scope
Requires a read-write key (READ_WRITE) with a responsible user.
Parameters
Name
In
Type
Required
Description
Authorization
header
string
yes
Bearer followed by the key. Alternative: X-API-Key header.
Idempotency-Key
header
string
no
Idempotency key (kept 24h, body up to 2 MB). Same key + same body returns the stored original response; same key + different body gets 409; same key while the first run is still going gets 409 with Retry-After: 5. A 5xx does not freeze the key.
Request body
Name
Type
Required
Description
nome
string
yes
Name.
email
string
no
E-mail.
cpfCnpj
string
no
Brazilian tax id (CPF or CNPJ), as registered.
telefone
string
no
Phone.
Response fields
Name
Type
Description
id
integer
Record identifier. Use it in by-id calls.
codigo
integer
Record code as shown on screen.
nome
string
Name.
Status codes
HTTP
Description
201
Created
401
Missing or invalid key
403
Key without write scope
Error messages
HTTP
Message (erro field)
When it happens
401
chave de API ausente ou inválida
No key header, revoked key or typo.
401
chave sem empresa vinculada
The key exists but is not linked to an account. Create another one in Settings › API.
403
conta de demonstração: a API pública está desligada na vitrine
The call reached the demo account, where the public API is turned off.
403
identidade da chave de API irregular
The account refuses keys with irregular identity (deactivated person or ownerless key). The body brings motivo and comoResolver.
429
limite de requisições excedido (120/min)
The key went over its per-minute limit. Wait for Retry-After.
403
esta chave é somente leitura — gere uma chave com escopo de escrita
Write with a read-only key.
409
a chave não tem usuário responsável; recrie a chave em Configurações → API para que os registros criados tenham autoria
The write key has no responsible user: without authorship nothing is saved.
400
Idempotency-Key é obrigatória em escrita desde 2026-12-01 (aviso publicado em 2026-09-01): sem ela, um retry de rede cria o registro duas vezes. Envie um valor único por operação no cabeçalho Idempotency-Key.
Write without Idempotency-Key after the mandatory date.
409
Idempotency-Key já usada com um corpo DIFERENTE — gere uma chave nova por operação
The same Idempotency-Key came with another body.
409
requisicao com esta Idempotency-Key ainda em processamento — aguarde e repita
The same Idempotency-Key arrived while the first call was still running. Retry after Retry-After.
400
JSON inválido
The body is not a valid JSON object.
422
nome é obrigatório
nome is missing or empty.
422
não foi possível criar: {detalhe}
The write was refused (for example, a value longer than the field allows). Details in the message.