Criar lead no Instantly, por uma API

Adiciona um lead a uma campanha ou a uma lista de leads. Um lead adicionado a uma campanha ativa entra na sequência e recebe emails conforme a agenda.

Identificador
instantly_create_lead

A chamada

POST https://connect.reportei.com/api/tools/instantly_create_lead/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "campaign": "<campaign>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
campaignstringNãoCampaign that gets the lead, by the id from List campaigns. Send it or list_id.
list_idstringNãoLead list that gets the lead, by the id from List lead lists. Send it or campaign.
emailstringNãoEmail of the lead, where the campaign sends.
first_namestringNãoFirst name of the lead.
last_namestringNãoLast name of the lead.
company_namestringNãoCompany of the lead.
job_titlestringNãoJob title of the lead.
phonestringNãoPhone of the lead.
websitestringNãoWebsite of the lead.
personalizationstringNãoPersonalized line the email copy can use for this lead.
custom_variablesobjectNãoExtra variables of the lead, as text, number or boolean values by name, like {"industry": "Retail"}. The campaign starts accepting the same variable names for its other leads.
skip_if_in_workspacebooleanNãoWhen true, skips the lead if its email is already anywhere in the workspace.
skip_if_in_campaignbooleanNãoWhen true, skips the lead if it is already in a campaign.
skip_if_in_listbooleanNãoWhen true, skips the lead if it is already in a lead list.

Conexões possíveis

O seu cliente conecta a conta do Instantly uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/instantly_create_lead. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Instantly

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.