v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
conversas-v2-contacts

Criar contato de WhatsApp Business por Broker

Criar contato do WhatsApp Business em um broker específico

post/v2/contacts/whatsapp-business-by-brokers

Request body

{"stackTrail":"components:schemas:BirthDateNullable","oasType":"schema","type":"unknown","description":"Data de nascimento no formato brasileiro (DD/MM/YYYY)."}
cel_phonestring required

Número no formato E.164: [CC][NDC][SN] (apenas dígitos). Exemplo (Brasil): 5511999998888.

{"stackTrail":"components:schemas:Cnpj","oasType":"schema","type":"unknown","description":"Número de CNPJ do contato."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:code","oasType":"schema","type":"unknown","description":"Código do contato."}
{"stackTrail":"components:schemas:Cpf","oasType":"schema","type":"unknown","description":"Número de CPF do contato."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:current_wallet","oasType":"schema","type":"unknown","description":"Nome da carteira ao qual o contato será inserido."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:department_name","oasType":"schema","type":"unknown","description":"Nome do setor que o contato será direcionado."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:description","oasType":"schema","type":"unknown","description":"Descrição."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:email","oasType":"schema","type":"unknown","description":"Endereço de e-mail do contato."}
full_namestring required

Nome completo do contato.

idstring hash
integrationstring required

Integração do WhatsApp a qual o contato será criado e atribuído.

{"stackTrail":"components:schemas:Rg","oasType":"schema","type":"unknown","description":"Número de RG do contato."}
tagsstring[]

Tags do contato.

{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:whatsapp_name","oasType":"schema","type":"unknown","description":"Nome da integração do WhatsApp Business."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:workflow_stage_title","oasType":"schema","type":"unknown","description":"Título do Estágio do Workflow ao qual o contato será atribuído (obrigatório se workflow_title for informado)."}
{"stackTrail":"components:schemas:CreateWhatsappBusinessContactByBrokersRequest:properties:workflow_title","oasType":"schema","type":"unknown","description":"Título do Workflow ao qual o contato será atribuído."}

Response

Contato criado com sucesso

messagestring required

Mensagem de callback.