> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/topicos/api/api-criando-um-lead.md).

# API - Criando um Lead

Como criar um Lead com dados a partir de uma requisição.

### Rota

<mark style="color:green;">`POST`</mark> `/leads?apitoken=seu-token&i=sua-instancia`

Endpoint completo: <mark style="color:green;"><https://sprinthub-api-master.sprinthub.app/leads?apitoken=seu-token\\&i=sua-instancia></mark>

### Query Params

<table><thead><tr><th width="291">Key/Chave</th><th width="450">Descrição</th></tr></thead><tbody><tr><td>i</td><td>Identificador da sua instância, subdomínio </td></tr><tr><td>apitoken</td><td>Token da API</td></tr></tbody></table>

### Body - Campos padrões do sistema

<table><thead><tr><th width="234">Key/Chave</th><th width="513">Valor esperado</th></tr></thead><tbody><tr><td>firstname</td><td><em>String</em></td></tr><tr><td>lastname</td><td><em>String</em></td></tr><tr><td>email</td><td><p><em>String</em></p><p><br>Somente um e-mail: <code>"email@mail"</code></p><p>Múltiplos e-mails: <code>"email1@mail.com, email2@mail.com"</code></p></td></tr><tr><td>whatsapp,<br>mobile (telefone celular),<br>phone (telefone fixo)</td><td><em>String</em><br><br>Formato: <code>"+55 11 97107 1713"</code></td></tr><tr><td>country</td><td><em>String</em><br><br>Escrito em inglês, por exemplo: <code>"Brazil"</code></td></tr><tr><td>state</td><td><em>String</em></td></tr><tr><td>city</td><td><em>String</em></td></tr><tr><td>address</td><td><em>String</em></td></tr><tr><td>zipcode (cep)</td><td><em>String</em><br><br>Formato: <code>"69092250"</code></td></tr><tr><td>timezone</td><td><em>String</em><br><br>Formato: <code>"America/Sao_Paulo"</code></td></tr><tr><td>preferred_locale <br>(idioma)</td><td><em>String</em><br><br>Formato: <code>"pt-BR"</code></td></tr></tbody></table>

## Exemplo de criação de Lead

Foram inseridos no corpo da requisição os dados a serem adicionados ao Lead. O envio da requisição foi feito utilizando o software *Postman*. A resposta esperada são os dados do Lead após o momento da criação, incluindo campos não preenchidos.

<figure><img src="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FzMDJtwb9W4N8oRTqkaWO%2Freq-2.png?alt=media&amp;token=90d5a473-438a-4ece-9ae2-bf117015a3fc" alt=""><figcaption><p><em>Requisição POST para criação de Lead.</em></p></figcaption></figure>
