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

Airship Export

markdownView as Markdown

Create and manage data import and export jobs.

AirshipExport: Create job

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

Create a AirshipExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "commercial_optin": "string",
    "commercial_optout": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "email": "string",
    "fields_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "list_name": "string",
    "list_url": "string",
    "run_frequency": "string",
    "segment_id": "string",
    "time_of_day": "string",
    "timezone": "string",
    "transactional_optin": "string",
    "transactional_optout": "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
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": {
      "commercial_optin": "string",
      "commercial_optout": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "email": "string",
      "fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "list_name": "string",
      "list_url": "string",
      "run_frequency": "string",
      "segment_id": "string",
      "time_of_day": "string",
      "timezone": "string",
      "transactional_optin": "string",
      "transactional_optout": "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
}

AirshipExport: Get job

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

Get the summary of a AirshipExport 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": {
      "commercial_optin": "string",
      "commercial_optout": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "email": "string",
      "fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "list_name": "string",
      "list_url": "string",
      "run_frequency": "string",
      "segment_id": "string",
      "time_of_day": "string",
      "timezone": "string",
      "transactional_optin": "string",
      "transactional_optout": "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
}

AirshipExport: Update job

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

Update a AirshipExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "commercial_optin": "string",
    "commercial_optout": "string",
    "continuous_update": true,
    "day_of_week": "string",
    "email": "string",
    "fields_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "list_name": "string",
    "list_url": "string",
    "run_frequency": "string",
    "segment_id": "string",
    "time_of_day": "string",
    "timezone": "string",
    "transactional_optin": "string",
    "transactional_optout": "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
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": {
      "commercial_optin": "string",
      "commercial_optout": "string",
      "continuous_update": true,
      "day_of_week": "string",
      "email": "string",
      "fields_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "list_name": "string",
      "list_url": "string",
      "run_frequency": "string",
      "segment_id": "string",
      "time_of_day": "string",
      "timezone": "string",
      "transactional_optin": "string",
      "transactional_optout": "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.commercial_optinoptionalstring

Select the field that contains the date the user opted into commercial emails. This will be used to register new users in Airship. If left blank will use the current time

config.commercial_optoutoptionalstring

Select the field that contains the date the user opted out of commercial emails. This will be used to register new users in Airship

config.continuous_updateoptionalboolean

Continuously run this export

config.day_of_weekoptionalstring

Day of week to run work

config.emailoptionalstring

Select the field that contains the user's email address. This will be used to register new users in Airship

config.fields_mappingoptionalobject[]

Map the Lytics fields to Airship Channel Identifiers

config.list_nameoptionalstring

Enter the list name you wish to create in Airship.

config.list_urloptionalstring

Select the list you want to export to, if you want to create a new list use the 'List Name' field below.

config.run_frequencyoptionalstring

Choose how often a continuous export should update the list

config.segment_idoptionalstring

Choose the audience that contains the users to export.

config.time_of_dayoptionalstring

Time of day to start export each day

config.timezoneoptionalstring

Timezone for time of day

config.transactional_optinoptionalstring

Select the field that contains the date the user opted into transactional emails. This will be used to register new users in Airship

config.transactional_optoutoptionalstring

Select the field that contains the date the user opted out of transactional emails. This will be used to register new users in Airship

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

Select the field that contains the date the user opted into commercial emails. This will be used to register new users in Airship. If left blank will use the current time

config.commercial_optoutoptionalstring

Select the field that contains the date the user opted out of commercial emails. This will be used to register new users in Airship

config.continuous_updateoptionalboolean

Continuously run this export

config.day_of_weekoptionalstring

Day of week to run work

config.emailoptionalstring

Select the field that contains the user's email address. This will be used to register new users in Airship

config.fields_mappingoptionalobject[]

Map the Lytics fields to Airship Channel Identifiers

config.list_nameoptionalstring

Enter the list name you wish to create in Airship.

config.list_urloptionalstring

Select the list you want to export to, if you want to create a new list use the 'List Name' field below.

config.run_frequencyoptionalstring

Choose how often a continuous export should update the list

config.segment_idoptionalstring

Choose the audience that contains the users to export.

config.time_of_dayoptionalstring

Time of day to start export each day

config.timezoneoptionalstring

Timezone for time of day

config.transactional_optinoptionalstring

Select the field that contains the date the user opted into transactional emails. This will be used to register new users in Airship

config.transactional_optoutoptionalstring

Select the field that contains the date the user opted out of transactional emails. This will be used to register new users in Airship

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