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

Salesforce Export

markdownView as Markdown

Create and manage data import and export jobs.

SalesforceExport: Create job

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

Create a SalesforceExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334353637
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "extra_fields": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "field_changes": [
      "string"
    ],
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "match_field": "string",
    "max_calls": 1,
    "salesforce_object": "string",
    "segment_ids": [
      "string"
    ],
    "segments_destination": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
{
  "_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": {
      "extra_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "field_changes": [
        "string"
      ],
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "match_field": "string",
      "max_calls": 1,
      "salesforce_object": "string",
      "segment_ids": [
        "string"
      ],
      "segments_destination": "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
}

SalesforceExport: Get job

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

Get the summary of a SalesforceExport job

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
{
  "_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": {
      "extra_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "field_changes": [
        "string"
      ],
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "match_field": "string",
      "max_calls": 1,
      "salesforce_object": "string",
      "segment_ids": [
        "string"
      ],
      "segments_destination": "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
}

SalesforceExport: Update job

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

Update a SalesforceExport job

Sample Request
12345678910111213141516171819202122232425262728293031323334353637
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "extra_fields": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "field_changes": [
      "string"
    ],
    "mappings": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "match_field": "string",
    "max_calls": 1,
    "salesforce_object": "string",
    "segment_ids": [
      "string"
    ],
    "segments_destination": "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
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
{
  "_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": {
      "extra_fields": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "field_changes": [
        "string"
      ],
      "mappings": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "match_field": "string",
      "max_calls": 1,
      "salesforce_object": "string",
      "segment_ids": [
        "string"
      ],
      "segments_destination": "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.extra_fieldsoptionalobject[]

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

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

config.mappingsoptionalobject[]

Map all the required fields from Lytics to Salesforce by selecting the Lytics field on the left, and its Salesforce destination on the right. All fields in the Salesforce dropdown must be mapped

config.match_fieldoptionalstring

Field in Salesforce to match records to avoid duplicates. Must be mapped in the fields below. If no match is found, the user will be omitted

config.max_callsoptionalinteger

The maximum number of API calls the Lytics export can make on your behalf per day. See [our docs](https://www.contentstack.com/docs/lytics/salesforce) for tips on finding and estimating this.

config.salesforce_objectoptionalstring
config.segment_idsoptionalstring[]

The Lytics audience(s) you'd like to send to Salesforce.

config.segments_destinationoptionalstring

Field in Salesforce to write Lytics audiences

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.extra_fieldsoptionalobject[]

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

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

config.mappingsoptionalobject[]

Map all the required fields from Lytics to Salesforce by selecting the Lytics field on the left, and its Salesforce destination on the right. All fields in the Salesforce dropdown must be mapped

config.match_fieldoptionalstring

Field in Salesforce to match records to avoid duplicates. Must be mapped in the fields below. If no match is found, the user will be omitted

config.max_callsoptionalinteger

The maximum number of API calls the Lytics export can make on your behalf per day. See [our docs](https://www.contentstack.com/docs/lytics/salesforce) for tips on finding and estimating this.

config.salesforce_objectoptionalstring
config.segment_idsoptionalstring[]

The Lytics audience(s) you'd like to send to Salesforce.

config.segments_destinationoptionalstring

Field in Salesforce to write Lytics audiences

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