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

Edita um lead existente

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

Edita um lead ativo identificado pelo id. Todos os campos do corpo são
opcionais — apenas os campos enviados são atualizados.

Regra null vs undefined

ComportamentoEfeito
Campo omitido (undefined)Ignorado — valor atual preservado
Campo null em coluna opcionalLimpa o campo
Campo null em coluna obrigatória (person, stageId, originId)Erro de validação

Comportamento por campo

  • person — busca ou cria a pessoa pelo contato informado (mesmo mecanismo do create) e associa ao lead. Os dados da pessoa anteriormente associada não são alterados.
  • stageId — move o lead para outro estágio dentro do pipeline atual. Estágios de outros pipelines não são aceitos. Stage de descarte exige o campo discardReasonId; use GET /v1/discard-reasons para listar os motivos disponíveis.
  • note — quando preenchido, cria uma nova nota no lead. Notas anteriores não são alteradas.
  • customFieldValues — quando enviado como array, apenas os campos presentes são atualizados; campos não incluídos no array permanecem intactos. null ou [] remove todos os valores de campos personalizados do lead.
  • tags — null ou [] remove todas as tags do lead.

Restrição

Apenas leads ativos podem ser editados. Leads convertidos ou descartados retornam erro.

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

ID do lead

Body Params

Corpo da edição de lead. Todos os campos são opcionais.
Campos omitidos são ignorados; null limpa um campo opcional.
null em campos obrigatórios (person, stageId, originId) causa erro de validação.

person
object

Re-associa o lead a outra pessoa via busca por contato (mesmo mecanismo do create). Não edita os dados da pessoa atual. null não é aceito.

string

ID do estágio de destino (deve pertencer ao pipeline atual do lead). null não é aceito.

string

ID da origem do lead. null não é aceito.

string

Motivo de descarte. Obrigatório quando stageId aponta para um estágio de descarte. Use GET /v1/discard-reasons para listar os IDs disponíveis.

integer | null
1 to 5

Avaliação do lead (1–5). null remove a avaliação.

number | null

Valor estimado do lead. null remove o valor.

string | null

ID do responsável. null remove o responsável (lead sem dono).

string

Quando não vazio, cria uma nova nota no lead ancorada no estágio atual. Não sobrescreve notas existentes.

tags
array of strings | null

IDs das tags associadas. null ou [] remove todas as tags.

tags
string | null

ID da campanha. null remove a campanha e zera campaignEnteredAt.

boolean
Defaults to false

Se verdadeiro, não dispara automações ao mover o estágio.

string | null

ID de origem do Facebook. null limpa o campo.

string | null

ID WACL do Facebook. null limpa o campo.

string | null

Google Click Identifier (GCLID). null limpa o campo.

customFieldValues
array of objects | null

Valores de campos personalizados.

  • Array com itens — upsert por campo: cada customFieldId presente é substituído; campos não citados no array permanecem intactos.
  • null ou [] — remove todos os valores de campos personalizados do lead.
  • Omitido — nenhum campo personalizado é alterado.

Regras de validação do value por tipo de campo (igual ao create):

  • select: string nas opções configuradas.
  • multiselect: string[] com cada item nas opções.
  • number: string numérica ("42", "3.14").
  • date / datetime: string ISO 8601 válida.
  • time: formato HH:mm.
  • text / textarea: qualquer string.

customFieldId inexistente retorna HTTP 400 customField.notFound.

customFieldValues
Responses

Updated about 2 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 about 2 months ago

Did this page help you?