Cadastrar um lead

Cria um lead à mão. O número é opcional: um lead pode existir só com o nome (um familiar, alguém conhecido pessoalmente). Quando informado, o número é normalizado para o formato brasileiro e não pode pertencer a outro lead do workspace (409 lead_identity_taken). O nome é marcado como definido pela equipe, então nenhuma importação ou canal o substitui depois. Aceita até 6 telefones de contato (phones, rótulos mobile, landline, work, message, other; não repetem o WhatsApp nem entre si, mas podem ser de outros leads, como o telefone de casa de uma família) e até 5 endereços (addresses, rótulos home, work, other, exatamente um primary quando há mais de um; cada um precisa de CEP ou de cidade com UF). A posição no mapa é do servidor: todo endereço novo entra como geoStatus pending, a não ser que traga pin {latitude, longitude}, o alfinete que a pessoa posicionou antes de salvar (exige também leads:update e leads:read_addresses, 403 forbidden ou lead_addresses_forbidden; o servidor confere o ponto, grava precisão exact e origem manual, e a geocodificação automática nunca o substitui; um ponto fora do Brasil ou inválido dá 400 lead_location_invalid). Um endereço só com pin e sem texto é aceito. Se o número já é de outro lead, a resposta é 409 lead_identity_taken com details.leadId (só para quem lê leads). Aceita customFields (mapa pela chave do campo personalizado de lead; campos obrigatórios são exigidos, um campo sensível só pode ser preenchido por quem tem leads:read_sensitive, 403 custom_field_sensitive_forbidden; recusas de valor dão 400 com a chave em details.key). A resposta traz em duplicates leads que podem ser a mesma pessoa (mesmo telefone, ou mesmo nome no mesmo endereço), um aviso que não impede o cadastro. Uma chave desconhecida no corpo é recusada com 400 invalid_body. 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_invalid, lead_phone_label_invalid, lead_phone_limit, lead_phone_repeats_identity, lead_phone_repeated, lead_address_invalid, lead_address_label_invalid, lead_address_limit, lead_address_primary; nos itens de lista, details traz field e index (e, no endereço, addressField e rule).

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

Dados do lead

addresses
array of objects
addresses
string
customFields
object
string
string
string
string
phones
array of objects
phones
boolean
Headers
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