Mettre à jour une campagne avec l'API Instantly
Modifie une campagne. Envoyez uniquement les champs à changer ; sequences et campaign_schedule remplacent entièrement les actuels.
- Identifiant
- instantly_update_campaign
L'appel
POST https://connect.reportei.com/api/tools/instantly_update_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| id | string | Oui | Id of the campaign, from List campaigns. |
| name | string | Non | New name of the campaign. |
| campaign_schedule | object | Non | When the campaign sends. |
| sequences | array | Non | The email copy, as a single sequence with its steps. Instantly only reads the first item. |
| email_list | array | Non | Sending accounts, by the email from List accounts. Replaces the current list. |
| daily_limit | integer | Non | Maximum emails the campaign sends per day. |
| daily_max_leads | integer | Non | Maximum new leads contacted per day. |
| email_gap | integer | Non | Minutes between two emails of the campaign. |
| stop_on_reply | boolean | Non | When true, a lead who replies gets no more steps. |
| stop_on_auto_reply | boolean | Non | When true, an automatic reply, like out of office, also stops the lead. |
| stop_for_company | boolean | Non | When true, a reply stops every lead of the same company domain. |
| open_tracking | boolean | Non | Whether to track opens. |
| link_tracking | boolean | Non | Whether to track link clicks. |
| text_only | boolean | Non | When true, every email goes as plain text. |
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_update_campaign. Il devient la définition de tool de votre agent sans conversion.
Autres tools Instantly
- Lister les campagnesGETListe les campagnes du workspace avec id, nom et statut, jusqu'à limit par page. Pour la page suivante, passez next_starting_after comme starting_after, jusqu'à ce qu'il ne revienne plus.
- Obtenir une campagneGETRenvoie une campagne avec statut, planning, sequences (les étapes d'email et leurs variantes), comptes d'envoi dans email_list et options d'envoi.
- Créer une campagnePOSTCrée une campagne en brouillon, avec son planning, ses étapes d'email et ses comptes d'envoi. Ajoutez des leads avec Create lead et lancez-la avec Activate campaign.
- Activer une campagnePOSTDémarre une campagne en brouillon ou reprend une campagne en pause. Instantly envoie alors les étapes aux leads de la campagne, depuis les comptes de email_list, dans le planning.
- Mettre une campagne en pausePOSTMet une campagne en pause : plus aucun email ne part tant qu'Activate campaign ne la reprend pas.
- Obtenir les statistiques d'une campagneGETRenvoie, par campagne, leads, contactés, emails envoyés, ouvertures, réponses, clics sur les liens, rebonds, désinscriptions, leads terminés et opportunités, pour une campagne ou pour toutes.
- Lister les leadsPOSTListe 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.
- Créer un leadPOSTAjoute 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.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
