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. Responsys Export

Responsys Export

markdownView as Markdown

Create and manage data import and export jobs.

ResponsysExport: Create job

POSThttps://api.lytics.io/v2/job/responsys-export

Create a ResponsysExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334353637383940414243
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "additional_fields": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "additional_membership_segment_ids": [
      "string"
    ],
    "continuous_update": true,
    "enrichment_template_id": "string",
    "field_changes": [
      "string"
    ],
    "fields_table": "string",
    "id_mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "list": "string",
    "match_column_1": "string",
    "match_column_2": "string",
    "segment_ids": [
      "string"
    ],
    "segment_membership_as": "entity"
  },
  "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
{
  "_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_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "additional_membership_segment_ids": [
        "string"
      ],
      "continuous_update": true,
      "enrichment_template_id": "string",
      "field_changes": [
        "string"
      ],
      "fields_table": "string",
      "id_mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "list": "string",
      "match_column_1": "string",
      "match_column_2": "string",
      "segment_ids": [
        "string"
      ],
      "segment_membership_as": "entity"
    },
    "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
}

ResponsysExport: Get job

GEThttps://api.lytics.io/v2/job/responsys-export/{id}

Get the summary of a ResponsysExport job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
{
  "_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_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "additional_membership_segment_ids": [
        "string"
      ],
      "continuous_update": true,
      "enrichment_template_id": "string",
      "field_changes": [
        "string"
      ],
      "fields_table": "string",
      "id_mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "list": "string",
      "match_column_1": "string",
      "match_column_2": "string",
      "segment_ids": [
        "string"
      ],
      "segment_membership_as": "entity"
    },
    "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
}

ResponsysExport: Update job

PUThttps://api.lytics.io/v2/job/responsys-export/{id}

Update a ResponsysExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334353637383940414243
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "additional_fields": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "additional_membership_segment_ids": [
      "string"
    ],
    "continuous_update": true,
    "enrichment_template_id": "string",
    "field_changes": [
      "string"
    ],
    "fields_table": "string",
    "id_mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "list": "string",
    "match_column_1": "string",
    "match_column_2": "string",
    "segment_ids": [
      "string"
    ],
    "segment_membership_as": "entity"
  },
  "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
{
  "_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_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "additional_membership_segment_ids": [
        "string"
      ],
      "continuous_update": true,
      "enrichment_template_id": "string",
      "field_changes": [
        "string"
      ],
      "fields_table": "string",
      "id_mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "list": "string",
      "match_column_1": "string",
      "match_column_2": "string",
      "segment_ids": [
        "string"
      ],
      "segment_membership_as": "entity"
    },
    "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_fieldsoptionalobject[]

Select up to 29 user fields to export to Lytics_User_Fields extension table

config.additional_membership_segment_idsoptionalstring[]

AdditionalMembershipSegmentIDs are evaluated per exported profile purely so the

enrichment template can see membership in them. Unlike SegmentIDs they are not part

of the export scope: they add no trigger and export no additional profiles.

config.continuous_updateoptionalboolean
config.enrichment_template_idoptionalstring

EnrichmentTemplateID, if set, renders the referenced template per user and merges its

output fields onto the user before export, so they can be mapped like native fields.

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user will be updated in Responsys.

config.fields_tableoptionalstring

Optionally select a fields extension table to write to. If none is selected, a new extension table Lytics_User_Fields_{Job ID} will be created. Note the field names must match the Lytics field names

config.id_mappingsoptionalobject[]

Map all the fields from Lytics to Responsys by selecting the Lytics field on the left and the Responsys destination on the right

config.listoptionalstring

The list in Responsys that you'd like to export data to

config.match_column_1optionalstring

Select the ID to use as the main identifier for matching

config.match_column_2optionalstring

Select the ID to use as the secondary identifier for matching

config.segment_idsrequiredstring[]

Select the Lytics audiences you'd like to export to Responsys.

config.segment_membership_asoptionalstring

SegmentMembershipAs controls how segment membership reaches the enrichment template:

"entity" (default) merges scoped _segments slugs into the data; "env" passes the

ly_segment_association env var (names + slugs).

One of: entity, env

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_fieldsoptionalobject[]

Select up to 29 user fields to export to Lytics_User_Fields extension table

config.additional_membership_segment_idsoptionalstring[]

AdditionalMembershipSegmentIDs are evaluated per exported profile purely so the

enrichment template can see membership in them. Unlike SegmentIDs they are not part

of the export scope: they add no trigger and export no additional profiles.

config.continuous_updateoptionalboolean
config.enrichment_template_idoptionalstring

EnrichmentTemplateID, if set, renders the referenced template per user and merges its

output fields onto the user before export, so they can be mapped like native fields.

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user will be updated in Responsys.

config.fields_tableoptionalstring

Optionally select a fields extension table to write to. If none is selected, a new extension table Lytics_User_Fields_{Job ID} will be created. Note the field names must match the Lytics field names

config.id_mappingsoptionalobject[]

Map all the fields from Lytics to Responsys by selecting the Lytics field on the left and the Responsys destination on the right

config.listoptionalstring

The list in Responsys that you'd like to export data to

config.match_column_1optionalstring

Select the ID to use as the main identifier for matching

config.match_column_2optionalstring

Select the ID to use as the secondary identifier for matching

config.segment_idsrequiredstring[]

Select the Lytics audiences you'd like to export to Responsys.

config.segment_membership_asoptionalstring

SegmentMembershipAs controls how segment membership reaches the enrichment template:

"entity" (default) merges scoped _segments slugs into the data; "env" passes the

ly_segment_association env var (names + slugs).

One of: entity, env

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