RDrdstation
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

  • Base URL
    https://api.tallos.com.br
  • URL
    https://api.tallos.com.br/v2/contacts/whatsapp-business-by-brokers
  • Auth
    HTTP bearer

Request body

birth_datestring nullable

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.

cnpjstring nullable

Número de CNPJ do contato.

codestring nullable

Código do contato.

cpfstring nullable

Número de CPF do contato.

current_walletstring nullable

Nome da carteira ao qual o contato será inserido.

department_namestring nullable

Nome do setor que o contato será direcionado.

descriptionstring nullable

Descrição.

emailstring email nullable

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.

rgstring nullable

Número de RG do contato.

tagsstring[] nullable

Tags do contato.

whatsapp_namestring nullable

Nome da integração do WhatsApp Business.

workflow_stage_titlestring nullable

Título do Estágio do Workflow ao qual o contato será atribuído (obrigatório se workflow_title for informado).

workflow_titlestring nullable

Título do Workflow ao qual o contato será atribuído.

Example request

{
  "address": {
    "city": "Fortaleza",
    "complement": "5º andar",
    "country": "Brazil",
    "district": "Centro",
    "number": "1234",
    "state": "Ceará",
    "street": "Av. Principal",
    "zip_code": "12345-600"
  },
  "birth_date": "30/03/1992",
  "cel_phone": "5511999998888",
  "cnpj": "12.345.678/0009-10",
  "cpf": "123.456.789-10",
  "full_name": "John Tallos",
  "id": "507f191e810c19729de860ea",
  "integration": "integration-1",
  "job": {
    "cnpj": "12.345.678/0009-10",
    "company": "RD Station",
    "department": "Controladoria",
    "phone": "+55 11 999-888-777",
    "site": "https://tallos.com.br",
    "title": "Gerente"
  },
  "rg": "12.345.678-9"
}

Response

Contato criado com sucesso

messagestring required

Mensagem de callback.

Example response

{
  "data": {
    "_id": "507f191e810c19729de860ea",
    "address": {
      "city": "Fortaleza",
      "complement": "5º andar",
      "country": "Brazil",
      "district": "Centro",
      "number": "1234",
      "state": "Ceará",
      "street": "Av. Principal",
      "zip_code": "12345-600"
    },
    "birth_date": "30/03/1992",
    "cel_phone": "+55 11 999-888-777",
    "cnpj": "12.345.678/0009-10",
    "cpf": "123.456.789-10",
    "customizable_field": [
      {
        "info": "123456",
        "label": "CRM"
      }
    ],
    "email": "john.tallos@email.com",
    "employee": "507f191e810c19729de860ea",
    "full_name": "Tallos Example",
    "integration": "integration-1",
    "job": {
      "cnpj": "12.345.678/0009-10",
      "company": "RD Station",
      "department": "Controladoria",
      "phone": "+55 11 999-888-777",
      "site": "https://tallos.com.br",
      "title": "Gerente"
    },
    "rg": "12.345.678-9"
  },
  "message": "Success created contact"
}

Changes

No recorded changes to this operation across all 1 revision of this API.