Update campaign with the Instantly API

Changes a campaign. Send only the fields to change; sequences and campaign_schedule replace the current ones whole.

Identifier
instantly_update_campaign

The request

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

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
idstringYesId of the campaign, from List campaigns.
namestringNoNew name of the campaign.
campaign_scheduleobjectNoWhen the campaign sends.
sequencesarrayNoThe email copy, as a single sequence with its steps. Instantly only reads the first item.
email_listarrayNoSending accounts, by the email from List accounts. Replaces the current list.
daily_limitintegerNoMaximum emails the campaign sends per day.
daily_max_leadsintegerNoMaximum new leads contacted per day.
email_gapintegerNoMinutes between two emails of the campaign.
stop_on_replybooleanNoWhen true, a lead who replies gets no more steps.
stop_on_auto_replybooleanNoWhen true, an automatic reply, like out of office, also stops the lead.
stop_for_companybooleanNoWhen true, a reply stops every lead of the same company domain.
open_trackingbooleanNoWhether to track opens.
link_trackingbooleanNoWhether to track link clicks.
text_onlybooleanNoWhen true, every email goes as plain text.

Supported connections

Your customer connects their Instantly account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/instantly_update_campaign. It becomes your agent's tool definition with no conversion.

Other Instantly tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.