Export v1.2

Exports subscriber data in CSV format.

What can I do with export?

Export endpoint can be used to export list or stored searchExecute results. The endpoint can also return results based on export type:

  • "dnc" export type can be used to export the doNotContact list. This operation is independent and therefore list_id or searchexecute_id are not applicable for this type of export.
  • "subscriber" export type can be used to export all subscribers in a list or stored searchExecute results.
  • "email_suspended" export type can be used to export subscribers that are suspended from receiving email campaigns due to bounces.
  • "sms_suspended" export type can be used to export subscribers that are suspended from receiving sms campaigns due to bounces.

GET /export or /export/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the export.
completed
boolYesNoFlag indicating whether export processing has completed.
list_id
int/nullYesNoUnique ID of the list from which data is to be exported.
name
stringNoNoThe name of the export.
recordcount
int/nullNoNoNumber of records in the export.
searchexecute_id
int/nullYesNoThe Unique ID of the searchexecute that maps to stored data to export.
suppressnotify
boolNoNoWhether to suppress sending a notification email to the user on completion of the export. Defaults to false.
type
enumNoNoThe type of export: 'subscriber', 'email_suspended', 'sms_suspended', 'dnc'.
url
string/nullNoNoIf export is complete, url to csv of export data.
user_id
intYesNoUnique ID of the user who created the export.
cdate
decimalNoYesTimestamp at which the export was created.
mdate
decimalNoYesTimestamp at which the export was last modified.

HEAD /export or /export/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the export.
completed
boolOptionalFlag indicating whether export processing has completed.
list_id
int/nullOptionalUnique ID of the list from which data is to be exported.
searchexecute_id
int/nullOptionalThe Unique ID of the searchexecute that maps to stored data to export.
user_id
intOptionalUnique ID of the user who created the export.

POST /export

AttributeTypePresenceDescription
list_id
int/nullRequired*Unique ID of the list from which data is to be exported.
name
stringRequiredThe name of the export.
searchexecute_id
int/nullRequired*The Unique ID of the searchexecute that maps to stored data to export.
suppressnotify
boolOptionalWhether to suppress sending a notification email to the user on completion of the export. Defaults to false.
type
enumRequiredThe type of export: 'subscriber', 'email_suspended', 'sms_suspended', 'dnc'.

* Exactly one of list_id and searchexecute_id must be present in a POST, unless type is 'dnc', in which case neither should be present.

If searchexecute_id is present, it must refer to a searchExecute resource where store is true and the data stored has not expired (stored data expires 7 days after creation).

PUT /export or /export/:id

This method is not supported.

DELETE /export or /export/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
	"id":               123,
	"completed":        true,
	"list_id":          456789,
	"name":             "List subscribers export",
	"recordcount":      5400,
	"searchexecute_id": null,
	"suppressnotify":   false
	"type":             "subscriber",
	"url":              "https://domain.com/path/to/data_file.csv",
	"user_id":          123,
	"cdate":            131674521,
	"mdate":            131674521
}