POST api/v1/BulkExport

Request Information

URI Parameters

None.

Body Parameters

ExportSettingsDto
NameDescriptionTypeAdditional 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.

ItemType

string

None.

SegmentId

integer

None.

Fields

Collection of string

None.

SuffixFileName

string

None.

TimeZoneId

string

None.

UseCompression

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Type": "Contacts",
  "DynamicTableId": 1,
  "ColumnDelimiter": "sample string 1",
  "RowDelimiter": "sample string 2",
  "CreatedDateTimeFrom": "2024-04-26T21:54:44.3877616+00:00",
  "CreatedDateTimeTo": "2024-04-26T21:54:44.3877616+00:00",
  "ItemType": "sample string 3",
  "SegmentId": 1,
  "Fields": [
    "sample string 1",
    "sample string 2"
  ],
  "SuffixFileName": "sample string 4",
  "TimeZoneId": "sample string 5",
  "UseCompression": true
}

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.