Editar um lead

Altera os campos enviados e mantém todos os outros como estão (campos ausentes nunca são apagados; envie "" para limpar um texto). Exige no cabeçalho If-Match a version lida: sem ela a resposta é 428 version_required; se o lead mudou depois da leitura, a resposta é 409 version_conflict com o registro atual em details.current, mostrando só o que você pode ler. O corpo aceita só number, name, nickname, email, birthDate, whatsappOptIn, phones, addresses e customFields; qualquer outra chave é recusada com 400 invalid_body, que nomeia a chave. whatsappOptIn true registra o consentimento como um registro manual de quem edita (exige também leads:consent, 403 forbidden); false sobre um consentimento registrado é uma retirada pela equipe (o lead passa a não receber mensagens), e false num lead sem consentimento não muda nada. customFields é um mapa parcial pela chave do campo: só as chaves enviadas mudam, null limpa uma chave, e as chaves ausentes (inclusive as sensíveis que você não pode ver) ficam como estão. Cada valor é conferido com o campo personalizado de lead do workspace (400 custom_field_unknown_key, custom_field_value_type, custom_field_value_not_in_options, custom_field_value_required, com a chave em details.key); escrever ou limpar um campo sensível exige leads:read_sensitive (403 custom_field_sensitive_forbidden). Enviar addresses exige leads:read_addresses (403 lead_addresses_forbidden), porque quem não tem essa permissão só vê o bairro e a cidade e substituiria a lista inteira sem ver o que apaga. phones e addresses, quando enviados, substituem a lista inteira (envie id para manter um item; um id que não é deste lead é recusado com lead_phone_unknown ou lead_address_unknown). Mudar o texto de um endereço devolve a posição para pending, a não ser que a posição tenha sido marcada à mão e keepPosition seja true; latitude e longitude nunca vêm do cliente como colunas do endereço; o alfinete posicionado à mão vem em pin {latitude, longitude} e é gravado no mesmo comando, com precisão exact e origem manual, pelas mesmas regras de POST /leads/{id}/addresses/{addressId}/pin (um ponto inválido dá 400 lead_location_invalid; a geocodificação automática nunca substitui esse alfinete). Trocar o número de WhatsApp (number) só é possível enquanto o lead não tem conversas (409 lead_identity_in_use: cadastre o número como telefone de contato); um número de outro lead dá 409 lead_identity_taken. O responsável (ownerId) muda por POST /leads/{id}/owner e o bloqueio por POST /leads/{id}/block. A resposta e o details.current do 409 mostram só o que você pode ler: campos sensíveis só para leads:read_sensitive e endereços completos só para leads:read_addresses (sem ela, cada endereço traz só bairro, cidade, UF e o código IBGE da cidade, sem CEP, rua, número, complemento nem posição). Códigos de 400: invalid_body, lead_identity_required, lead_number_invalid, lead_name_too_long, lead_nickname_too_long, lead_email_invalid, lead_birth_date_invalid, lead_phone_*, lead_address_*.

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

ID do lead (UUID)

Body Params

Campos a alterar

addresses
array of objects
addresses
string
customFields
object
string
string
string
string
phones
array of objects
phones
boolean
Headers
string
required

version lida do lead

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json