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

Iterable Export

markdownView as Markdown

Create and manage data import and export jobs.

IterableExport: Create job

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

Create a IterableExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "convert_maps": true,
    "email_field": "string",
    "field_changes": [
      "string"
    ],
    "fields": [
      "string"
    ],
    "id_field": "string",
    "include_segs": true,
    "list": "string",
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "max_bytes": 0,
    "prefer_email": true,
    "segment_id": "string",
    "segment_ids": [
      "string"
    ]
  },
  "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_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": {
      "convert_maps": true,
      "email_field": "string",
      "field_changes": [
        "string"
      ],
      "fields": [
        "string"
      ],
      "id_field": "string",
      "include_segs": true,
      "list": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "max_bytes": 0,
      "prefer_email": true,
      "segment_id": "string",
      "segment_ids": [
        "string"
      ]
    },
    "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
}

IterableExport: Get job

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

Get the summary of a IterableExport job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_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": {
      "convert_maps": true,
      "email_field": "string",
      "field_changes": [
        "string"
      ],
      "fields": [
        "string"
      ],
      "id_field": "string",
      "include_segs": true,
      "list": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "max_bytes": 0,
      "prefer_email": true,
      "segment_id": "string",
      "segment_ids": [
        "string"
      ]
    },
    "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
}

IterableExport: Update job

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

Update a IterableExport job

Sample Request
1234567891011121314151617181920212223242526272829303132333435363738
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "convert_maps": true,
    "email_field": "string",
    "field_changes": [
      "string"
    ],
    "fields": [
      "string"
    ],
    "id_field": "string",
    "include_segs": true,
    "list": "string",
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "max_bytes": 0,
    "prefer_email": true,
    "segment_id": "string",
    "segment_ids": [
      "string"
    ]
  },
  "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
{
  "_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": {
      "convert_maps": true,
      "email_field": "string",
      "field_changes": [
        "string"
      ],
      "fields": [
        "string"
      ],
      "id_field": "string",
      "include_segs": true,
      "list": "string",
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "max_bytes": 0,
      "prefer_email": true,
      "segment_id": "string",
      "segment_ids": [
        "string"
      ]
    },
    "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.convert_mapsoptionalboolean

Convert Lytics map fields into an array of key-value objects in Iterable. This minimizes the field count in Iterable. Uncheck if you would like to send map fields to Iterable as they are in Lytics; this can lead to a high field count since each distinct key will count as a new field in Iterable

config.email_fieldoptionalstring
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 Iterable.

config.fieldsoptionalstring[]

Select a list of user fields to create in Iterable. In Iterable, the created field will have the name inside the ()

config.id_fieldoptionalstring
config.include_segsoptionalboolean

Select to include the entity's audience membership as a data field called 'LyticsAudiences'

config.listoptionalstring

Choose the list to export to, or enter a name to create a new list in Iterable

config.mappingsoptionalobject[]

Map all the fields from Lytics to Iterable by selecting the Lytics field on the left, and its Iterable destination on the right

config.max_bytesoptionalinteger
config.prefer_emailoptionalboolean

Select to always prefer email address over user ID. This will stop users from being created if the email address does not exist in Iterable

config.segment_idoptionalstring

Choose the audience of users to export to Iterable

config.segment_idsoptionalstring[]

Select the audiences of users to export to Iterable

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.convert_mapsoptionalboolean

Convert Lytics map fields into an array of key-value objects in Iterable. This minimizes the field count in Iterable. Uncheck if you would like to send map fields to Iterable as they are in Lytics; this can lead to a high field count since each distinct key will count as a new field in Iterable

config.email_fieldoptionalstring
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 Iterable.

config.fieldsoptionalstring[]

Select a list of user fields to create in Iterable. In Iterable, the created field will have the name inside the ()

config.id_fieldoptionalstring
config.include_segsoptionalboolean

Select to include the entity's audience membership as a data field called 'LyticsAudiences'

config.listoptionalstring

Choose the list to export to, or enter a name to create a new list in Iterable

config.mappingsoptionalobject[]

Map all the fields from Lytics to Iterable by selecting the Lytics field on the left, and its Iterable destination on the right

config.max_bytesoptionalinteger
config.prefer_emailoptionalboolean

Select to always prefer email address over user ID. This will stop users from being created if the email address does not exist in Iterable

config.segment_idoptionalstring

Choose the audience of users to export to Iterable

config.segment_idsoptionalstring[]

Select the audiences of users to export to Iterable

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