O método permite adicionar leads com contatos e uma empresa à sua conta em lotes. Os dados adicionados podem ser verificados no controle duplicado.
Limitações
- O método está disponível de acordo com os direitos do usuário.
- Para um único lead, você pode especificar no máximo um contato relacionado e uma empresa relacionada.
- Para as entidades adicionadas (lead, contato, empresa), você pode transferir no máximo 40 valores de campos adicionais.
- Os dados que você adicionar participam do controle duplicado se a opção estiver habilitada para a integração que adiciona os dados.
- O método não realiza controle de duplicidade para leads já adicionados entre si.
- O método não realiza controle de duplicidade para leads na mesma solicitação.
- O método procura duplicatas entre os leads atuais adicionados e os já existentes.
- Você pode adicionar no máximo 50 leads por solicitação.
- Ao criar um novo contato e empresa, eles serão vinculados automaticamente.
Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json
Cabeçalho de tipo de dado em caso de erro
Content-Type: application/problem+json
Exemplo de Resposta
A primeira vez que você inserir o lead, ele será adicionado normalmente.
[
{
"id": 9774766,
"contact_id": 12117258,
"company_id": 12117260,
"request_id": [
"1"
],
"merged": false
}
]
Agora, vamos alterar um pouco o corpo da requisição. Por exemplo, vamos alterar o nome e o ID da requisição e enviá-la novamente. De acordo com as regras de controle duplicado na nossa conta e pipeline onde realizamos a requisição, o lead é considerado um duplicado. A resposta com o valor true da flag merged será recebida.
[
{
"id": 9774766,
"contact_id": 12117258,
"company_id": 12117260,
"request_id": [
"2"
],
"merged": true
}
]
Parâmetros de resposta
| Parâmetros | Descrição |
|---|---|
| id | ID do Lead |
| contact_id | ID do Contato |
| company_id | ID da Empresa |
| request_id | Um array de IDs de requisição que foram adicionados. Se nenhuma duplicata for encontrada, o array sempre terá um elemento. Se várias duplicatas do mesmo lead forem passadas, o array request_id conterá os identificadores dos leads passados, que são duplicatas. |
| merged | Uma flag que indica se uma duplicata foi encontrada de acordo com as condições para busca de duplicatas e se a mesclagem foi realizada. |
Saiba mais sobre metadata e custom_fields_values, usados nos parâmetros do corpo da requisição.