Mailing
Mailing Documentation
Mailing [POST]
Mailing [POST]
Request
Endpoint
POST api/v2/contacts/exports/mailing
Content-Type: application/vnd.api+json
Body
{
"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
Content-Type: application/vnd.api+json; charset=utf-8
201 Created
Body
{
"data": {
"id": "59776061-9958-41ef-b638-f51e192035c4",
"type": "export_logs",
"attributes": {
"created_at": "2021-11-23T14:38:21Z",
"export_at": "2021-11-23T14:38:21Z",
"params": {
"filter": "{\"status\":\"active\"}"
},
"type": "Contacts Mailing",
"updated_at": "2021-11-23T14:38:21Z",
"updated_in_db_at": "2021-11-23T14:38:21Z"
},
"relationships": {
"user": {
"data": {
"id": "541ca7ef-f018-438f-b43f-132612e15b48",
"type": "users"
}
}
}
}
}
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
GET api/v2/contacts/exports/mailing/ad6a15f7-3630-4d3e-8389-fb8acf124c38
Content-Type: application/vnd.api+json
Body
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "ad6a15f7-3630-4d3e-8389-fb8acf124c38",
"type": "export_logs",
"attributes": {
"created_at": "2021-11-23T14:38:21Z",
"export_at": "2017-07-28T15:19:32Z",
"params": {
"filter": {
"status": "active"
}
},
"type": "Contacts Export",
"updated_at": "2021-11-23T14:38:21Z",
"updated_in_db_at": "2021-11-23T14:38:21Z"
},
"relationships": {
"user": {
"data": {
"id": "94d9f4d6-150e-4a35-998f-6434e283aea2",
"type": "users"
}
}
}
}
}
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