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. Marketingcloud Journey

Marketingcloud Journey

markdownView as Markdown

Create and manage data import and export jobs.

MarketingcloudJourney: Create job

POSThttps://api.lytics.io/v2/job/marketingcloud-journey

Create a MarketingcloudJourney job

Sample Request
12345678910111213141516171819202122232425262728293031323334
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "additional_segments": [
      "string"
    ],
    "contact_key_field": "string",
    "event_def_key": "string",
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "segment_id": "string",
    "segments_field": "string",
    "user_limit": 0,
    "user_limit_day_of_week": "string",
    "user_limit_frequency": "string",
    "user_limit_time_of_day": "string",
    "user_limit_timezone": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
{
  "_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": {
      "additional_segments": [
        "string"
      ],
      "contact_key_field": "string",
      "event_def_key": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_id": "string",
      "segments_field": "string",
      "user_limit": 0,
      "user_limit_day_of_week": "string",
      "user_limit_frequency": "string",
      "user_limit_time_of_day": "string",
      "user_limit_timezone": "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
}

MarketingcloudJourney: Get job

GEThttps://api.lytics.io/v2/job/marketingcloud-journey/{id}

Get the summary of a MarketingcloudJourney job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
{
  "_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": {
      "additional_segments": [
        "string"
      ],
      "contact_key_field": "string",
      "event_def_key": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_id": "string",
      "segments_field": "string",
      "user_limit": 0,
      "user_limit_day_of_week": "string",
      "user_limit_frequency": "string",
      "user_limit_time_of_day": "string",
      "user_limit_timezone": "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
}

MarketingcloudJourney: Update job

PUThttps://api.lytics.io/v2/job/marketingcloud-journey/{id}

Update a MarketingcloudJourney job

Sample Request
12345678910111213141516171819202122232425262728293031323334
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "additional_segments": [
      "string"
    ],
    "contact_key_field": "string",
    "event_def_key": "string",
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "segment_id": "string",
    "segments_field": "string",
    "user_limit": 0,
    "user_limit_day_of_week": "string",
    "user_limit_frequency": "string",
    "user_limit_time_of_day": "string",
    "user_limit_timezone": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
{
  "_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": {
      "additional_segments": [
        "string"
      ],
      "contact_key_field": "string",
      "event_def_key": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_id": "string",
      "segments_field": "string",
      "user_limit": 0,
      "user_limit_day_of_week": "string",
      "user_limit_frequency": "string",
      "user_limit_time_of_day": "string",
      "user_limit_timezone": "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.additional_segmentsoptionalstring[]

Select additional Lytics audiences to send to the Audience Field specified above. Audience slugs will be sent concatenated by a comma, field may be limited by size

config.contact_key_fieldrequiredstring

Select the mapped field from above that contains the ID that uniquely identifies a Marketing Cloud subscriber/contact

config.event_def_keyrequiredstring
config.mappingsoptionalobject[]

Select all the fields to send to Marketing Cloud by mapping the Lytics user profile field on the left to the Marketing Cloud field on the right

config.segment_idoptionalstring

Choose the Lytics audience to send to Marketing Cloud

config.segments_fieldoptionalstring

Select a field to write the additional Lytics audiences to

config.user_limitoptionalinteger

Maximum number of users to send before the limit resets at the specified time. Set to 0 for no limit.

config.user_limit_day_of_weekoptionalstring

Select the day of the week to reset the user limit count

config.user_limit_frequencyoptionalstring

Select how frequently to reset the user limit count

config.user_limit_time_of_dayoptionalstring

Select the time of day to reset the user limit count

config.user_limit_timezoneoptionalstring

Select the timezone for the time of day to reset the user limit count

config.withbackfilloptionalboolean

Trigger events for 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.additional_segmentsoptionalstring[]

Select additional Lytics audiences to send to the Audience Field specified above. Audience slugs will be sent concatenated by a comma, field may be limited by size

config.contact_key_fieldrequiredstring

Select the mapped field from above that contains the ID that uniquely identifies a Marketing Cloud subscriber/contact

config.event_def_keyrequiredstring
config.mappingsoptionalobject[]

Select all the fields to send to Marketing Cloud by mapping the Lytics user profile field on the left to the Marketing Cloud field on the right

config.segment_idoptionalstring

Choose the Lytics audience to send to Marketing Cloud

config.segments_fieldoptionalstring

Select a field to write the additional Lytics audiences to

config.user_limitoptionalinteger

Maximum number of users to send before the limit resets at the specified time. Set to 0 for no limit.

config.user_limit_day_of_weekoptionalstring

Select the day of the week to reset the user limit count

config.user_limit_frequencyoptionalstring

Select how frequently to reset the user limit count

config.user_limit_time_of_dayoptionalstring

Select the time of day to reset the user limit count

config.user_limit_timezoneoptionalstring

Select the timezone for the time of day to reset the user limit count

config.withbackfilloptionalboolean

Trigger events for 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