Lister les leads avec l'API Instantly

Liste les leads avec email, noms, entreprise, statut et statut d'intérêt, jusqu'à limit par page. Pour la page suivante, passez next_starting_after comme starting_after, jusqu'à ce qu'il ne revienne plus.

Identifiant
instantly_list_leads

L'appel

POST https://connect.reportei.com/api/tools/instantly_list_leads/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
campaignstringNonOnly leads of this campaign, by the id from List campaigns.
list_idstringNonOnly leads of this lead list, by the id from List lead lists.
searchstringNonWhole words, or the start of a value, matched against email, names, company and job title. Leads created a few seconds ago may not show yet.
filterstringNonOnly leads in this state, like FILTER_VAL_REPLIED for leads that replied or FILTER_LEAD_INTERESTED for leads marked as interested.Valeurs : FILTER_VAL_CONTACTED, FILTER_VAL_NOT_CONTACTED, FILTER_VAL_COMPLETED, FILTER_VAL_UNSUBSCRIBED, FILTER_VAL_ACTIVE, FILTER_LEAD_INTERESTED, FILTER_LEAD_NOT_INTERESTED, FILTER_LEAD_MEETING_BOOKED, FILTER_LEAD_MEETING_COMPLETED, FILTER_LEAD_CLOSED, FILTER_LEAD_OUT_OF_OFFICE, FILTER_LEAD_WRONG_PERSON, FILTER_LEAD_LOST, FILTER_LEAD_NO_SHOW, FILTER_VAL_BOUNCED, FILTER_VAL_SKIPPED, FILTER_VAL_REPLIED, FILTER_VAL_OPENED_NO_REPLY, FILTER_VAL_COMPLETED_NO_REPLY, FILTER_VAL_NO_OPENS, FILTER_VAL_LINK_CLICKED
contactsarrayNonOnly leads with these emails.
idsarrayNonOnly these leads, by the id from a previous call of List leads.
in_campaignbooleanNonTrue for leads that are in a campaign, false for leads outside any campaign.
in_listbooleanNonTrue for leads that are in a lead list, false for leads outside any list.
limitintegerNonLeads per page, up to 100.
starting_afterstringNonThe next_starting_after of the previous page.

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_list_leads. 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.