Update email campaign activity with the Constant Contact API
Updates the primary_email activity of a campaign in DRAFT or DONE status. It replaces the properties: send the current sender, subject, preheader and lists from Get email campaign activity along with the changes, because what is left out is cleared. html_content and physical_address_in_footer are kept when not sent.
- Identifier
- constant_contact_update_email_campaign_activity
The request
POST https://connect.reportei.com/api/tools/constant_contact_update_email_campaign_activity/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"campaign_activity_id": "<campaign_activity_id>",
"from_name": "<from_name>",
"from_email": "<from_email>",
"reply_to_email": "<reply_to_email>",
"subject": "<subject>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_activity_id | string | Yes | Id of the activity with role primary_email, from Get email campaign or Create email campaign. |
| contact_list_ids | array | No | Ids of the lists that receive the email, from List contact lists. Required before scheduling, unless the activity uses a segment. |
| segment_ids | array | No | The segment that receives the email, as returned by Get email campaign activity. Send it back to keep it. Never together with contact_list_ids. |
| from_name | string | Yes | Sender name shown to contacts. |
| from_email | string | Yes | Sender address, a confirmed email address of the account. |
| reply_to_email | string | Yes | Address that receives the replies, a confirmed email address of the account. |
| subject | string | Yes | Subject of the email. |
| preheader | string | No | Short summary shown after the subject in the inbox. |
| html_content | string | No | New HTML body, only for format_type 5. Keep [[trackingImage]] inside the body element so opens and clicks are reported. |
| physical_address_in_footer | object | No | Address of the sender shown in the footer. state_code is required when country_code is US. |
Supported connections
Your customer connects their Constant Contact account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/constant_contact, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
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/constant_contact_update_email_campaign_activity. It becomes your agent's tool definition with no conversion.
Other Constant Contact tools
- List contactsGETLists the contacts of the account, leaving deleted ones out by default, optionally filtered by email, list, status or date. The response has contacts and, when there are more, _links.next.href with the cursor of the next page.
- Create contactPOSTCreates a contact and returns it with its contact_id. Send create_source and at least email_address, first_name or last_name. An email address that already exists in the account answers 409.
- Update contactPUTUpdates a contact by replacing its core fields: email_address, names, job_title, company_name, birthday and anniversary left out become empty, so send the current values too, from List contacts. Subresources left out are kept, and one that is sent replaces the current one.
- List contact listsGETLists the contact lists with their list_id, name and description. An account has up to 1000 lists, and one page brings up to 1000.
- Create contact listPOSTCreates an empty contact list and returns it with its list_id. A name already used by another list answers 409.
- List email campaignsGETLists the email campaigns, most recently updated first, with campaign_id, name, type and current_status, including the deleted ones (Removed). Up to 500 per page; reach older ones with before_date and after_date. The activity ids come from Get email campaign.
- Get email campaignGETReturns one email campaign with its name, current_status and campaign_activities. The campaign_activity_id with role primary_email is the one the activity tools take.
- Create email campaignPOSTCreates a draft email campaign with custom HTML content and returns it with campaign_activities, where the primary_email activity is. To send it, set the lists with Update email campaign activity and then use Schedule email campaign activity.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
