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ètreTypeObligatoireDescription
idstringOuiId of the campaign, from List campaigns.
namestringNonNew name of the campaign.
campaign_scheduleobjectNonWhen the campaign sends.
sequencesarrayNonThe email copy, as a single sequence with its steps. Instantly only reads the first item.
email_listarrayNonSending accounts, by the email from List accounts. Replaces the current list.
daily_limitintegerNonMaximum emails the campaign sends per day.
daily_max_leadsintegerNonMaximum new leads contacted per day.
email_gapintegerNonMinutes between two emails of the campaign.
stop_on_replybooleanNonWhen true, a lead who replies gets no more steps.
stop_on_auto_replybooleanNonWhen true, an automatic reply, like out of office, also stops the lead.
stop_for_companybooleanNonWhen true, a reply stops every lead of the same company domain.
open_trackingbooleanNonWhether to track opens.
link_trackingbooleanNonWhether to track link clicks.
text_onlybooleanNonWhen 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

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.