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. Tiktok Offline Events

Tiktok Offline Events

markdownView as Markdown

Create and manage data import and export jobs.

TiktokOfflineEvents: Create job

POSThttps://api.lytics.io/v2/job/tiktok-offline-events

Create a TiktokOfflineEvents job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "audience_events": "enters_only",
    "event_id": "string",
    "event_name": "string",
    "event_source": "string",
    "event_time": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "offline_event_set_id": "string",
    "property_mapping": [
      {
        "property1": "string",
        "property2": "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
{
  "_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": {
      "audience_events": "enters_only",
      "event_id": "string",
      "event_name": "string",
      "event_source": "string",
      "event_time": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "offline_event_set_id": "string",
      "property_mapping": [
        {
          "property1": "string",
          "property2": "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
}

TiktokOfflineEvents: Get job

GEThttps://api.lytics.io/v2/job/tiktok-offline-events/{id}

Get the summary of a TiktokOfflineEvents job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
{
  "_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": {
      "audience_events": "enters_only",
      "event_id": "string",
      "event_name": "string",
      "event_source": "string",
      "event_time": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "offline_event_set_id": "string",
      "property_mapping": [
        {
          "property1": "string",
          "property2": "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
}

TiktokOfflineEvents: Update job

PUThttps://api.lytics.io/v2/job/tiktok-offline-events/{id}

Update a TiktokOfflineEvents job

Sample Request
123456789101112131415161718192021222324252627282930313233343536373839
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "audience_events": "enters_only",
    "event_id": "string",
    "event_name": "string",
    "event_source": "string",
    "event_time": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "offline_event_set_id": "string",
    "property_mapping": [
      {
        "property1": "string",
        "property2": "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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
{
  "_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": {
      "audience_events": "enters_only",
      "event_id": "string",
      "event_name": "string",
      "event_source": "string",
      "event_time": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "offline_event_set_id": "string",
      "property_mapping": [
        {
          "property1": "string",
          "property2": "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.audience_eventsoptionalstring

Select which type of audience trigger events to send to TikTok. By default both enters and exits with be sent.

One of: enters_only, exits_only

config.event_idoptionalstring

Select user field that contains a unique event ID for deduplication

config.event_nameoptionalstring

Select the action source for this conversion. If Action Source is not mapped or the user field is empty, this value will be used

config.event_sourceoptionalstring

Select the Event Name associated with this conversion. If Event Name is not mapped or the user field is empty, this value will be used

config.event_timeoptionalstring

Select user field that contains the event time

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 field change event will be sent to the TikTok API.

config.identifier_mappingrequiredobject[]

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

config.offline_event_set_idrequiredstring

Enter the Offline Event Set ID associated with these conversions

config.property_mappingrequiredobject[]

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

config.segment_idsrequiredstring[]

Select the audiences to export

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

Select which type of audience trigger events to send to TikTok. By default both enters and exits with be sent.

One of: enters_only, exits_only

config.event_idoptionalstring

Select user field that contains a unique event ID for deduplication

config.event_nameoptionalstring

Select the action source for this conversion. If Action Source is not mapped or the user field is empty, this value will be used

config.event_sourceoptionalstring

Select the Event Name associated with this conversion. If Event Name is not mapped or the user field is empty, this value will be used

config.event_timeoptionalstring

Select user field that contains the event time

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 field change event will be sent to the TikTok API.

config.identifier_mappingrequiredobject[]

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

config.offline_event_set_idrequiredstring

Enter the Offline Event Set ID associated with these conversions

config.property_mappingrequiredobject[]

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

config.segment_idsrequiredstring[]

Select the audiences to export

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