Mailing
Mailing Documentation
Mailing [POST]
Mailing [POST]
Request
Endpoint
POST api/v2/contacts/exports/mailing
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "export_logs",
"attributes": {
"params": {
"filter": "{\"status\":\"active\"}"
}
}
}
}Parameters
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
Required No
params
Type
string
Description A contact filter object that will select the contacts to export
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
export_at
Type
string
Description When export was performed
params
Type
string
Description A contact filter object that will select the contacts to export
type
Type
string
Description The type of export being performed
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
user.data
Type
Person
Description The user that created the export
Mailing [GET]
This endpoint when .csv or .xlsx is appended to the URI Path will produce a file with the contacts selected by the params attribute of the export_log
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
created_at
Type
date
Description The timestamp of when this resource was created
export_at
Type
string
Description When export was performed
params
Type
string
Description A contact filter object that will select the contacts to export
type
Type
string
Description The type of export being performed
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
user.data
Type
Person
Description The user that created the export
Last updated