Campaign Monitor
Add and list subscribers in Campaign Monitor email lists.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("campaign_monitor", "add_subscriber_to_list", {
"clientId": "<clientId>",
"listId": "<listId>",
"email": "<email address>",
"consentToTrack": "Yes",
"fields": {}
});
if (!res.success) throw new Error(res.error);
ctx.log.info("Campaign Monitor answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "campaign-monitor-add-subscriber-to-list",
name: "Campaign Monitor: Add Subscriber",
description: "Calls Campaign Monitor when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("campaign_monitor", {
"action": "add_subscriber_to_list",
"clientId": "<clientId>",
"listId": "<listId>",
"email": "<email address>",
"consentToTrack": "Yes",
"fields": {}
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/campaign_monitor/add_subscriber_to_list" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"clientId":"<clientId>","listId":"<listId>","email":"<email address>","consentToTrack":"Yes","fields":{}}}'Actions
add_subscriber_to_listin catalog
Add Subscriber. Adds a new subscriber to a list.
| Input | Type | Description |
|---|---|---|
clientIdrequired | id (picked from your account) | Client Account |
listIdrequired | id (picked from your account) | List ID |
emailrequired | text | Email Address |
nameoptional | text | Name |
phoneoptional | text | Phone |
consentToTrackrequired | one of "Yes" | "No" | "Unchanged" | Whether the subscriber has consented to tracking. |
consentToSendSmsoptional | one of "Yes" | "No" | "Unchanged" | Whether the subscriber has consented to send SMS. |
resubscribeoptional | boolean | If true, the subscriber will be resubscribed if they previously unsubscribed. |
fieldsrequired | object (depends on other props) | Custom Fields |
find_subscriberin catalog
Find Subscriber. Find a subscriber by email in a specific list.
| Input | Type | Description |
|---|---|---|
clientIdrequired | id (picked from your account) | Client Account |
listIdrequired | id (picked from your account) | List ID |
emailrequired | text | The email address of the subscriber to find |
unsubscribe_subscriberin catalog
Unsubscribe Subscriber. Remove a subscriber from a list.
| Input | Type | Description |
|---|---|---|
clientIdrequired | id (picked from your account) | Client Account |
listIdrequired | id (picked from your account) | List ID |
emailrequired | text | The email address of the subscriber to unsubscribe. |
update_subscriber_detailsin catalog
Update Subscriber. Update an existing subscriber in a list.
| Input | Type | Description |
|---|---|---|
clientIdrequired | id (picked from your account) | Client Account |
listIdrequired | id (picked from your account) | List ID |
emailrequired | text | Email Address |
nameoptional | text | Name |
phoneoptional | text | Phone |
consentToTrackoptional | one of "Yes" | "No" | "Unchanged" | Whether the subscriber has consented to tracking. |
consentToSendSmsoptional | one of "Yes" | "No" | "Unchanged" | Whether the subscriber has consented to send SMS. |
resubscribeoptional | boolean | If true, the subscriber will be resubscribed if they previously unsubscribed. |
fieldsrequired | object (depends on other props) | Custom Fields |
Details
- Id
campaign_monitor- Category
- Marketing
- Tags
- email, campaigns, newsletter, subscribers
- Package
@activepieces/piece-campaign-monitor@0.1.4- Tier
- Community