Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Campaignmonitor Activate

Campaignmonitor Activate

markdownView as Markdown

Create and manage data import and export jobs.

CampaignmonitorActivate: Create job

POSThttps://api.lytics.io/v2/job/campaignmonitor-activate

Create a CampaignmonitorActivate job

Sample Request
12345678910111213141516171819202122232425262728293031
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "client_id": "string",
    "email_field": "string",
    "list_id": "string",
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "name_field": "string",
    "queue_subscription": true,
    "resubscribe": true,
    "segment_ids": [
      "string"
    ],
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "client_id": "string",
      "email_field": "string",
      "list_id": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "name_field": "string",
      "queue_subscription": true,
      "resubscribe": true,
      "segment_ids": [
        "string"
      ],
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

CampaignmonitorActivate: Get job

GEThttps://api.lytics.io/v2/job/campaignmonitor-activate/{id}

Get the summary of a CampaignmonitorActivate job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "client_id": "string",
      "email_field": "string",
      "list_id": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "name_field": "string",
      "queue_subscription": true,
      "resubscribe": true,
      "segment_ids": [
        "string"
      ],
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

CampaignmonitorActivate: Update job

PUThttps://api.lytics.io/v2/job/campaignmonitor-activate/{id}

Update a CampaignmonitorActivate job

Sample Request
12345678910111213141516171819202122232425262728293031
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "client_id": "string",
    "email_field": "string",
    "list_id": "string",
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "name_field": "string",
    "queue_subscription": true,
    "resubscribe": true,
    "segment_ids": [
      "string"
    ],
    "withbackfill": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "client_id": "string",
      "email_field": "string",
      "list_id": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "name_field": "string",
      "queue_subscription": true,
      "resubscribe": true,
      "segment_ids": [
        "string"
      ],
      "withbackfill": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.client_idoptionalstring

Choose the Campaign Monitor account you would like to export to

config.email_fieldoptionalstring

The field name that contains the user's email

config.list_idoptionalstring

Select the list where you'd like Lytics to send audience members. Note: duplicate users across lists in Campaign Monitor results in a bill per user per list.

config.mappingsoptionalobject[]

Map Lytics user fields to Campaign Monitor custom fields for the selected list

config.name_fieldoptionalstring

The field name that contains the user's full name

config.queue_subscriptionoptionalboolean

Check this box to automate workflow emails that are based on the subscription date. On Campaign Monitor, emails are not sent by default when subscribers are imported into an email campaign based on the subscription date

config.resubscribeoptionalboolean

Add users who have previously been deleted or unsubscribed from the Campaign Monitor list

config.segment_idsoptionalstring[]

The name of the Lytics audiences that contains the users you want to sync to Campaign Monitor. Lytics will create segments within the Campaign Monitor list for each selected audience.

config.withbackfilloptionalboolean

Add users who already exist in the selected Lytics audience

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.client_idoptionalstring

Choose the Campaign Monitor account you would like to export to

config.email_fieldoptionalstring

The field name that contains the user's email

config.list_idoptionalstring

Select the list where you'd like Lytics to send audience members. Note: duplicate users across lists in Campaign Monitor results in a bill per user per list.

config.mappingsoptionalobject[]

Map Lytics user fields to Campaign Monitor custom fields for the selected list

config.name_fieldoptionalstring

The field name that contains the user's full name

config.queue_subscriptionoptionalboolean

Check this box to automate workflow emails that are based on the subscription date. On Campaign Monitor, emails are not sent by default when subscribers are imported into an email campaign based on the subscription date

config.resubscribeoptionalboolean

Add users who have previously been deleted or unsubscribed from the Campaign Monitor list

config.segment_idsoptionalstring[]

The name of the Lytics audiences that contains the users you want to sync to Campaign Monitor. Lytics will create segments within the Campaign Monitor list for each selected audience.

config.withbackfilloptionalboolean

Add users who already exist in the selected Lytics audience

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring