> ## Documentation Index
> Fetch the complete documentation index at: https://docs.suasofia.online/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar lead

> Criar um novo lead para o usuário autenticado.

Este endpoint permite que você crie um novo lead para o usuário autenticado.

### Corpo da requisição

<ParamField body="phone_number" type="string" required>
  O número de telefone do lead no formato E.164 (por exemplo, +1234567890)
</ParamField>

<ParamField body="campaign_id" type="integer" required>
  O ID da campanha para criar o lead
</ParamField>

<ParamField body="variables" type="object">
  Variáveis personalizadas para passar para o lead. Você pode incluir **quaisquer variáveis que estejam definidas no seu assistente** (veja [Variáveis de chamada](/ai-assistants/settings/prompt-and-tools#call-variables)). Os exemplos abaixo são apenas para ilustração — use seus próprios nomes de variáveis conforme configurado nas configurações do assistente.

  <Expandable title="Variáveis de exemplo (adicione as suas)">
    <ParamField body="customer_name" type="string">
      por ex., o nome do cliente
    </ParamField>

    <ParamField body="email" type="string">
      por ex., o email do cliente
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="allow_dupplicate" type="boolean">
  Se deve permitir leads duplicados em uma campanha.
</ParamField>

<ParamField body="secondary_contacts" type="array">
  Array de leads de contatos secundários a serem criados junto com o lead principal

  <Expandable title="secondary_contacts properties">
    <ParamField body="phone_number" type="string" required>
      O número de telefone do contato secundário no formato E.164
    </ParamField>

    <ParamField body="variables" type="object">
      As variáveis a serem passadas para o contato secundário

      <Expandable title="variables properties">
        <ParamField body="customer_name" type="string" default="<string>">
          O nome do contato secundário
        </ParamField>

        <ParamField body="email" type="string" default="<string>">
          O email do contato secundário
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

### Resposta

<ResponseField name="message" type="string" default="Lead criado com sucesso">
  A mensagem da resposta
</ResponseField>

<ResponseField name="data" type="object">
  O objeto de dados do lead

  <Expandable title="data properties">
    <ResponseField name="id" type="integer">
      O ID único do lead criado
    </ResponseField>

    <ResponseField name="campaign_id" type="integer">
      O ID da campanha à qual este lead pertence
    </ResponseField>

    <ResponseField name="phone_number" type="string">
      O número de telefone do lead no formato E.164
    </ResponseField>

    <ResponseField name="variables" type="object">
      As variáveis associadas ao lead

      <Expandable title="variables properties">
        <ResponseField name="customer_name" type="string" default="<string>">
          O nome do cliente
        </ResponseField>

        <ResponseField name="email" type="string" default="<string>">
          O email do cliente
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="string" default="created">
      O status do lead
    </ResponseField>

    <ResponseField name="created_at" type="string">
      O timestamp de quando o lead foi criado
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      O timestamp de quando o lead foi atualizado pela última vez
    </ResponseField>

    <ResponseField name="campaign" type="object">
      As informações da campanha

      <Expandable title="campaign properties">
        <ResponseField name="id" type="integer">
          O id da campanha
        </ResponseField>

        <ResponseField name="name" type="string">
          O nome da campanha
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="secondary_contacts" type="array">
      Array de leads de contatos secundários associados a este lead

      <Expandable title="secondary_contacts properties">
        <ResponseField name="id" type="integer">
          O id do lead do contato secundário
        </ResponseField>

        <ResponseField name="phone_number" type="string">
          O número de telefone do contato secundário no formato E.164
        </ResponseField>

        <ResponseField name="variables" type="object">
          As variáveis associadas ao contato secundário
        </ResponseField>

        <ResponseField name="status" type="string">
          O status do contato secundário
        </ResponseField>

        <ResponseField name="created_at" type="string">
          A data de criação do contato secundário
        </ResponseField>

        <ResponseField name="updated_at" type="string">
          A data de atualização do contato secundário
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 Response theme={null}
  {
    "message": "Lead criado com sucesso",
    "data": {
      "id": 1,
      "campaign_id": 1,
      "phone_number": "+1234567890",
      "variables": {
        "customer_name": "João Silva",
        "email": "joao.silva@exemplo.com"
      },
      "status": "created",
      "created_at": "2025-06-30 11:53:20",
      "updated_at": "2025-06-30 11:53:20",
      "campaign": {
        "id": 1,
        "name": "Minha nova campanha"
      },
      "secondary_contacts": [
        {
          "id": 2,
          "phone_number": "+1234567891",
          "variables": {
            "customer_name": "Maria Silva Secundário",
            "email": "maria.silva.secundario@exemplo.com"
          },
          "status": "created",
          "created_at": "2025-06-30 11:53:20",
          "updated_at": "2025-06-30 11:53:20"
        },
        {
          "id": 3,
          "phone_number": "+1234567892",
          "variables": {
            "customer_name": "Roberto Silva Escritório",
            "email": "roberto.silva.escritorio@exemplo.com"
          },
          "status": "created",
          "created_at": "2025-06-30 11:53:20",
          "updated_at": "2025-06-30 11:53:20"
        }
      ]
    }
  }
  ```
</ResponseExample>