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. Amazon Ads Export Audience

Amazon Ads Export Audience

markdownView as Markdown

Create and manage data import and export jobs.

AmazonAdsExportAudience: Create job

POSThttps://api.lytics.io/v2/job/amazon-ads-export-audience

Create a AmazonAdsExportAudience job

Sample Request
1234567891011121314151617181920212223242526272829
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_storage_consent": "GRANTED",
    "advertiser_id": "string",
    "country_code": "CA",
    "external_user_id": "string",
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "profile_id": "string",
    "segment_id": "string",
    "user_data_consent": "GRANTED",
    "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "_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": {
      "ad_storage_consent": "GRANTED",
      "advertiser_id": "string",
      "country_code": "CA",
      "external_user_id": "string",
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "profile_id": "string",
      "segment_id": "string",
      "user_data_consent": "GRANTED",
      "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
}

AmazonAdsExportAudience: Get job

GEThttps://api.lytics.io/v2/job/amazon-ads-export-audience/{id}

Get the summary of a AmazonAdsExportAudience job

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "_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": {
      "ad_storage_consent": "GRANTED",
      "advertiser_id": "string",
      "country_code": "CA",
      "external_user_id": "string",
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "profile_id": "string",
      "segment_id": "string",
      "user_data_consent": "GRANTED",
      "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
}

AmazonAdsExportAudience: Update job

PUThttps://api.lytics.io/v2/job/amazon-ads-export-audience/{id}

Update a AmazonAdsExportAudience job

Sample Request
1234567891011121314151617181920212223242526272829
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "ad_storage_consent": "GRANTED",
    "advertiser_id": "string",
    "country_code": "CA",
    "external_user_id": "string",
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "profile_id": "string",
    "segment_id": "string",
    "user_data_consent": "GRANTED",
    "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
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
{
  "_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": {
      "ad_storage_consent": "GRANTED",
      "advertiser_id": "string",
      "country_code": "CA",
      "external_user_id": "string",
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "profile_id": "string",
      "segment_id": "string",
      "user_data_consent": "GRANTED",
      "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.ad_storage_consentoptionalstring

Amazon ad storage consent status

One of: GRANTED, DENIED, NOT_APPLICABLE, UNKNOWN

config.advertiser_idrequiredstring

Enter your Amazon Ads Advertiser ID

config.country_codeoptionalstring

Select the 2 letter country code where the users are located

One of: CA, DE, ES, FR, IN, IT, JP, UK, US

config.external_user_idoptionalstring

Select the Lytics user field that contains the external user id. If left empty, the email or phone number identifier that is mapped in identifier mapping will be used as the external user id.

config.identifier_mappingoptionalobject[]

Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.

config.profile_idrequiredstring

The Amazon DSP Profile/region you wish to export to

config.segment_idrequiredstring

Select the Lytics audience that contains the users to export

config.user_data_consentoptionalstring

Amazon user data consent status for Digital Markets Act compliance

One of: GRANTED, DENIED, NOT_APPLICABLE, UNKNOWN

config.withbackfilloptionalboolean

Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the 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.ad_storage_consentoptionalstring

Amazon ad storage consent status

One of: GRANTED, DENIED, NOT_APPLICABLE, UNKNOWN

config.advertiser_idrequiredstring

Enter your Amazon Ads Advertiser ID

config.country_codeoptionalstring

Select the 2 letter country code where the users are located

One of: CA, DE, ES, FR, IN, IT, JP, UK, US

config.external_user_idoptionalstring

Select the Lytics user field that contains the external user id. If left empty, the email or phone number identifier that is mapped in identifier mapping will be used as the external user id.

config.identifier_mappingoptionalobject[]

Map Lytics user fields to Amazon Ads PII. We will hash (SHA256) the identifiers before we send them to Amazon Ads. You can also select a field that is already hashed.

config.profile_idrequiredstring

The Amazon DSP Profile/region you wish to export to

config.segment_idrequiredstring

Select the Lytics audience that contains the users to export

config.user_data_consentoptionalstring

Amazon user data consent status for Digital Markets Act compliance

One of: GRANTED, DENIED, NOT_APPLICABLE, UNKNOWN

config.withbackfilloptionalboolean

Select this to immediately push users who currently exist in the selected Lytics audience. Deselecting will only push users as they leave or enter the 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