POST api/v1/BulkExport

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Type	What type of data should be exported ( Contacts, Stores, Points etc)? If the data is from a Dynamic Table - Type must be null	ExportType	None.
DynamicTableId	Id of the Dynamic Table If the data that should be exported are from a Dynamic Table - The DynamicTableId must be provided If it is not from a Dynamic Table - The DynamicTableId must be null	integer	None.
ColumnDelimiter		string	None.
RowDelimiter		string	None.
CreatedDateTimeFrom		date	None.
CreatedDateTimeTo		date	None.
LastModifiedFrom	Optional LastModified-based window for incremental sync. Only honored by exporters whose underlying table has a real LastModified column (Contacts, PointSums, PushTokens, SmsReceivers). For tables that only have Created, use CreatedDateTimeFrom/To instead.	date	None.
LastModifiedTo		date	None.
LastId	Optional integer-id watermark for insert-only exports. Exporters that honor it add AND Id > @LastId. Use this for tables like ContactEvents / Email2Interactions where a strict per-row cursor is preferable to a date window.	integer	None.
ItemType		string	None.
SegmentId		integer	None.
Fields	The columns to export, in place of the type's default projection. Rejected with a 400 if it names a column the type can't produce — GET api/v1/BulkExport/Fields returns the valid names for a type, including the account's dynamic fields.	Collection of string	None.
SuffixFileName		string	None.
TimeZoneId		string	None.
UseCompression		boolean	None.
Format	Output format. Defaults to Csv. Parquet is not supported for ContactExport-scoped exports.	ExportFormat	None.
Encoding	Character encoding of the exported file. Only applies to the Csv format. Defaults to Utf8 (without a byte order mark); use Utf8Bom for a leading BOM (EF BB BF), which Excel needs in order to read the file as UTF-8.	ExportEncoding	None.

Request Formats

application/json, text/json

Sample:

{
  "Type": "Contacts",
  "DynamicTableId": 1,
  "ColumnDelimiter": "sample string 1",
  "RowDelimiter": "sample string 2",
  "CreatedDateTimeFrom": "2026-09-11T15:38:53.227408+02:00",
  "CreatedDateTimeTo": "2026-09-11T15:38:53.227408+02:00",
  "LastModifiedFrom": "2026-09-11T15:38:53.227408+02:00",
  "LastModifiedTo": "2026-09-11T15:38:53.227408+02:00",
  "LastId": 1,
  "ItemType": "sample string 3",
  "SegmentId": 1,
  "Fields": [
    "sample string 1",
    "sample string 2"
  ],
  "SuffixFileName": "sample string 4",
  "TimeZoneId": "sample string 5",
  "UseCompression": true,
  "Format": "Csv",
  "Encoding": "Utf8"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.