Skip to main content
PATCH
Atualizar lead

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
name
string

Nome do lead

Example:

"Guilherme Gavazzoni"

image
string

Url da Imagem do lead

Example:

"https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/1163f5c2-62f4-443f-a84f-9c223b05ae3b"

phone
string

Telefone do lead

Example:

"+55 (47) 991331190"

email
string

Email do lead

Example:

"guilherme@datacrazy.com.br"

source
string

Origem do lead

Example:

"Google ads"

company
string

Empresa do lead

Example:

"Apple"

birthDate
string<date-time>

Data de nascimento do lead

Example:

"2000-01-01T00:00:00.000Z"

taxId
string

Documento de identificação

Example:

"108.154.702-92"

site
string

Site do lead

Example:

"www.meulead.com.br"

instagram
string

Instagram do lead

Example:

"@guilhermegavazzoni"

address
object

Endereço vinculado ao lead

Example:
addresses
object[]

Todos os endereços vinculados ao lead (o principal também é retornado em address)

Example:
sourceReferral
object

Fonte de referencia do lead

additionalFields
string[]

Campos adicionais do lead

type
string

Tipo do lead (PERSON ou COMPANY)

Example:

"PERSON"

displayName
string

Nome de exibição do lead

Example:

"DataCrazy Softwares"

sector
string

Setor de atuação

Example:

"Tecnologia"

role
string

Cargo do lead

Example:

"Diretor"

notes
string

Notas/Observações do lead

Example:

"Observações gerais sobre o lead"

parentId
string

ID do lead pai

Example:

"15b41959-b04d-4a99-b878-6e45fffa7633"

primaryContactLeadId
string

ID do lead contato principal (quando tipo COMPANY)

Example:

"15b41959-b04d-4a99-b878-6e45fffa7633"

tags
object[]

Array de ID de tags

lists
object[]

Array de ID de listas

attendant
object

ID do atendente

Response

200 - application/json
id
string

Id do lead

Example:

"15b41959-b04d-4a99-b878-6e45fffa7633"

createdAt
string<date-time>

Data de criação do lead

Example:

"2025-06-11T18:31:25.203Z"

name
string

Nome do lead

Example:

"Guilherme Gavazzoni"

image
string

Url da Imagem do lead

Example:

"https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/1163f5c2-62f4-443f-a84f-9c223b05ae3b"

phone
string

Telefone do lead

Example:

"+55 (47) 991331190"

rawPhone
string

Telefone do lead (apenas números)

Example:

"5547991331190"

email
string

Email do lead

Example:

"guilherme@datacrazy.com.br"

source
string

Origem do lead

Example:

"Google ads"

company
string

Empresa do lead

Example:

"Apple"

birthDate
string<date-time>

Data de nascimento do lead

Example:

"2000-01-01T00:00:00.000Z"

taxId
string

Documento de identificação

Example:

"108.154.702-92"

site
string

Site do lead

Example:

"www.meulead.com.br"

instagram
string

Instagram do lead

Example:

"@guilhermegavazzoni"

address
object

Endereço vinculado ao lead

Example:
addresses
object[]

Todos os endereços vinculados ao lead (o principal também é retornado em address)

Example:
tags
object

ID das tags atreladas ao lead

Example:
lists
string[]

Array de listas atreladas ao lead

Example:
contacts
object

Array de contatos atrelados ao lead

Example:
metrics
object

Métricas referentes ao lead

Example:
attendant
object

Atual atendente do lead

Example:
sourceReferral
object

Fonte de referencia do lead

additionalFields
string[]

Campos adicionais do lead

type
string

Tipo do lead (PERSON ou COMPANY)

Example:

"PERSON"

displayName
string

Nome de exibição do lead

Example:

"DataCrazy Softwares"

sector
string

Setor de atuação

Example:

"Tecnologia"

role
string

Cargo do lead

Example:

"Diretor"

notes
string

Notas/Observações do lead

Example:

"Observações gerais sobre o lead"

parentId
string

ID do lead pai

Example:

"15b41959-b04d-4a99-b878-6e45fffa7633"

primaryContactLeadId
string

ID do lead contato principal (quando tipo COMPANY)

Example:

"15b41959-b04d-4a99-b878-6e45fffa7633"

primaryContact
object

Contato principal do lead empresa

primaryContactFor
object[]

Empresas das quais o lead é contato principal

relationships
object[]

Relacionamentos do lead