Cria um novo lead

post

https://public-api.unocrm.com.br/v1/leads

Cria um lead associado a um stage, origem e (opcionalmente) campanha.
O contato (person) precisa ter ao menos um meio de contato.

Para enviar valores de campos personalizados via customFieldValues, utilize
os IDs retornados por GET /v1/custom-fields ou copie o ID diretamente na
página Configurações > Campos Personalizados do CRM.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

person

object

required

stageId

string

required

ID do estágio onde o lead será criado

originId

string

required

ID da origem do lead

rating

integer | null

1 to 5

Avaliação do lead de 1 a 5

price

number

Valor estimado do lead

userId

string | null

ID do usuário responsável pelo lead

note

string

Observação inicial do lead

tags

campaignId

string | null

ID da campanha associada

ignoreAutomation

boolean

Defaults to false

Se verdadeiro, não dispara automações ao criar o lead

facebookSourceId

string | null

ID de origem do Facebook (ex.: ad source)

facebookWaclId

string | null

ID WACL do Facebook

gclId

string | null

Google Click Identifier (GCLID) — rastreio de origem Google Ads

customFieldValues

array of objects | null

Valores de campos personalizados da empresa.

Regras de validação:

select: value deve ser string e estar nas opções configuradas.
multiselect: value deve ser string[]; cada item deve estar nas opções.
number: value deve ser string parseável como número ("42", "3.14").
date / datetime: value deve ser string ISO 8601 válida.
time: value deve ter formato HH:mm.
text / textarea: qualquer string é aceita.

Em qualquer falha de validação, a API retorna HTTP 400.

Para listar os campos disponíveis e seus IDs, use GET /v1/custom-fields.
Alternativamente, o ID de cada campo pode ser copiado na página
Configurações > Campos Personalizados do CRM.

customFieldValues

Responses

201Lead criado com sucesso

400Requisição inválida (validação de payload)

401API Key ausente ou inválida

409Pessoa já possui lead ativo

429Limite de requisições excedido