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. Dotmailer Import

Dotmailer Import

markdownView as Markdown

Create and manage data import and export jobs.

DotmailerImport: Create job

POSThttps://api.lytics.io/v2/job/dotmailer-import

Create a DotmailerImport job

Sample Request
123456789101112131415161718192021222324
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "activity_end": "2019-08-24T14:15:22Z",
    "activity_start": "2019-08-24T14:15:22Z",
    "address_book_status_field": "string",
    "continuous_update": true,
    "email_field": "string",
    "filter_fields": [
      "string"
    ],
    "tracking_slug": "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
{
  "_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": {
      "activity_end": "2019-08-24T14:15:22Z",
      "activity_start": "2019-08-24T14:15:22Z",
      "address_book_status_field": "string",
      "continuous_update": true,
      "email_field": "string",
      "filter_fields": [
        "string"
      ],
      "tracking_slug": "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
}

DotmailerImport: Get job

GEThttps://api.lytics.io/v2/job/dotmailer-import/{id}

Get the summary of a DotmailerImport job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
{
  "_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": {
      "activity_end": "2019-08-24T14:15:22Z",
      "activity_start": "2019-08-24T14:15:22Z",
      "address_book_status_field": "string",
      "continuous_update": true,
      "email_field": "string",
      "filter_fields": [
        "string"
      ],
      "tracking_slug": "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
}

DotmailerImport: Update job

PUThttps://api.lytics.io/v2/job/dotmailer-import/{id}

Update a DotmailerImport job

Sample Request
123456789101112131415161718192021222324
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "activity_end": "2019-08-24T14:15:22Z",
    "activity_start": "2019-08-24T14:15:22Z",
    "address_book_status_field": "string",
    "continuous_update": true,
    "email_field": "string",
    "filter_fields": [
      "string"
    ],
    "tracking_slug": "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
{
  "_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": {
      "activity_end": "2019-08-24T14:15:22Z",
      "activity_start": "2019-08-24T14:15:22Z",
      "address_book_status_field": "string",
      "continuous_update": true,
      "email_field": "string",
      "filter_fields": [
        "string"
      ],
      "tracking_slug": "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.activity_endoptionalstring (date-time)

Set in conjunction with Activity Backfill Start Date to pull in a set of activity by date. If this is set, the import will only pull in activity data; no contacts will be imported

config.activity_startoptionalstring (date-time)

Set in conjunction with Activity Backfill End Date to pull in a set of activity by date. If this is left empty, a default of 90 days of activity data will be pulled in

config.address_book_status_fieldoptionalstring

Select the field that contains the address book status. This is used to mark users that have unsubscribed from the account as unsubscribed from their address books. This field must be a map[string]string in the format of '[accountID]_[addressBookId]':'[status]'

config.continuous_updateoptionalboolean
config.email_fieldoptionalstring

Field that contains the contact's email

config.filter_fieldsoptionalstring[]

Select the fields to import for each contact from dotdigital

config.tracking_slugoptionalstring

Enter a slug to use to track the work. This slug should be unique

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.activity_endoptionalstring (date-time)

Set in conjunction with Activity Backfill Start Date to pull in a set of activity by date. If this is set, the import will only pull in activity data; no contacts will be imported

config.activity_startoptionalstring (date-time)

Set in conjunction with Activity Backfill End Date to pull in a set of activity by date. If this is left empty, a default of 90 days of activity data will be pulled in

config.address_book_status_fieldoptionalstring

Select the field that contains the address book status. This is used to mark users that have unsubscribed from the account as unsubscribed from their address books. This field must be a map[string]string in the format of '[accountID]_[addressBookId]':'[status]'

config.continuous_updateoptionalboolean
config.email_fieldoptionalstring

Field that contains the contact's email

config.filter_fieldsoptionalstring[]

Select the fields to import for each contact from dotdigital

config.tracking_slugoptionalstring

Enter a slug to use to track the work. This slug should be unique

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