API Reference
  1. UNO CRM - Public API
  2. Leads

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 distribuir o responsável automaticamente entre os usuários de uma roleta,
envie rotationId com o ID de uma roleta retornada por GET /v1/rotations.
userId tem precedência sobre a roleta: quando os dois vêm juntos, o lead fica
com o userId informado e a roleta não avança de posição.

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
person
object
required
string
required

ID do estágio onde o lead será criado

string
required

ID da origem do lead

integer | null
1 to 5

Avaliação do lead de 1 a 5

number

Valor estimado do lead

string | null

ID do usuário responsável pelo lead

uuid

ID de uma roleta ativa (GET /v1/rotations). Quando informado sem userId, o responsável pelo lead é o próximo usuário da roleta. Quando userId também é enviado, ele vence e a roleta não avança. Roleta inexistente, inativa ou sem usuários retorna 422 e o lead não é criado.

string

Observação inicial do lead

tags
array of strings

IDs das tags associadas

tags
string | null

ID da campanha associada

boolean
Defaults to false

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

string | null

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

string | null

ID WACL do Facebook

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

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?