Export Endpoint | Sign-Up.to Permission Marketing API

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

Attribute	Type	Filter	Sort	Description
id	int	Yes	Yes	Unique ID of the export.
completed	bool	Yes	No	Flag indicating whether export processing has completed.
list_id	int/null	Yes	No	Unique ID of the list from which data is to be exported.
name	string	No	No	The name of the export.
recordcount	int/null	No	No	Number of records in the export.
searchexecute_id	int/null	Yes	No	The Unique ID of the searchexecute that maps to stored data to export.
suppressnotify	bool	No	No	Whether to suppress sending a notification email to the user on completion of the export. Defaults to false.
type	enum	No	No	The type of export: 'subscriber', 'email_suspended', 'sms_suspended', 'dnc'.
url	string/null	No	No	If export is complete, url to csv of export data.
user_id	int	Yes	No	Unique ID of the user who created the export.
cdate	decimal	No	Yes	Timestamp at which the export was created.
mdate	decimal	No	Yes	Timestamp at which the export was last modified.

HEAD /export or /export/:id

Attribute	Type	Presence	Description
id	int	Optional	Unique ID of the export.
completed	bool	Optional	Flag indicating whether export processing has completed.
list_id	int/null	Optional	Unique ID of the list from which data is to be exported.
searchexecute_id	int/null	Optional	The Unique ID of the searchexecute that maps to stored data to export.
user_id	int	Optional	Unique ID of the user who created the export.

POST /export

Attribute	Type	Presence	Description
list_id	int/null	Required*	Unique ID of the list from which data is to be exported.
name	string	Required	The name of the export.
searchexecute_id	int/null	Required*	The Unique ID of the searchexecute that maps to stored data to export.
suppressnotify	bool	Optional	Whether to suppress sending a notification email to the user on completion of the export. Defaults to false.
type	enum	Required	The 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
}