Créer un lead avec l'API Instantly

Ajoute un lead à une campagne ou à une liste de leads. Un lead ajouté à une campagne active entre dans la séquence et reçoit des emails selon le planning.

Identifiant
instantly_create_lead

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
campaignstringNonCampaign that gets the lead, by the id from List campaigns. Send it or list_id.
list_idstringNonLead list that gets the lead, by the id from List lead lists. Send it or campaign.
emailstringNonEmail of the lead, where the campaign sends.
first_namestringNonFirst name of the lead.
last_namestringNonLast name of the lead.
company_namestringNonCompany of the lead.
job_titlestringNonJob title of the lead.
phonestringNonPhone of the lead.
websitestringNonWebsite of the lead.
personalizationstringNonPersonalized line the email copy can use for this lead.
custom_variablesobjectNonExtra 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_workspacebooleanNonWhen true, skips the lead if its email is already anywhere in the workspace.
skip_if_in_campaignbooleanNonWhen true, skips the lead if it is already in a campaign.
skip_if_in_listbooleanNonWhen true, skips the lead if it is already in a lead list.

Connexions possibles

Votre client connecte son compte Instantly une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/instantly_create_lead. Il devient la définition de tool de votre agent sans conversion.

Autres tools Instantly

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.