Skip to main content
POST
Cria ou atualiza um lead (upsert)

Authorizations

Authorization
string
header
required

Authorization: Bearer mcp_… — gere em Configurações → Tokens de API.

O token de API tem modo read ou write. Um token read responde 403 a qualquer verbo que não seja GET. As capacidades do token são a interseção com as da pessoa de quem ele herda o papel: se ela perder acesso na grade de Equipe, o token perde junto, sem ninguém revogar nada.

Token de agência (gerado no console da agência): vale para as empresas da agência, e a empresa de cada chamada vai no header X-Empresa: <slug da empresa>. Sem o header, 401. Num token de empresa o header é opcional e, se vier, tem de ser a própria empresa. O modo read vale igual: um token de agência de leitura só faz GET — é o token para pôr numa função que só consulta.

Body

application/json
phone
string

Com DDD; qualquer formatação.

Example:

"11987654321"

email
string
Example:

"ana@exemplo.com"

name
string
Maximum string length: 120
origem
enum<string>
default:manual

Só para lead novo. form = a pessoa pediu contato (é o que libera a primeira mensagem de POST /v1/conversas e dos fluxos).

Available options:
form,
manual
campos
object

Pela chave do campo (GET /v1/campos). null ou vazio limpa.

Example:
tags
string[]
Example:
stage
string

Nome da etapa aberta; com mais de um funil, Funil › Etapa.

Example:

"Lead"

utm
object
visita_codigo
string
Example:

"K7M2PQ"

Response

Já existia (mudou diz o que mudou; vazio = nada)

id
string<uuid>
criado
boolean

true = 201, o lead nasceu agora.

mudou
string[]

O que mudou num lead que já existia: name, email, stage, tags, visita, campos.<chave>.

campos_ignorados
string[]

Chaves de campo que não existem na empresa.

tags_ignoradas
string[]

Tags que não existem na empresa.

visita_ligada
boolean

O clique da visita (visita_codigo de 9) entrou no lead.