List all mailings

GET
/v4/mailings

Returns a list of mailings. Up to 100 mailings are returned per request.

Query parameters

pageintegerOptional

The specific page of results you’re requesting. Responses are limited to a maximum of 100 records.

statusenumOptional

Filters the list of mailings based on the status field.

Allowed values: CREATEDPROCESSING_FOR_DELIVERYIN_TRANSITDELIVEREDRETURNED_TO_SENDER
userIdstringOptional

The unique identifier for a single end-user of your application.

Response

OK

createdAtdatetime

The creation date and time of the mailing in ISO 8601 format.

fromobject

The mailing address of the sender.

idstring

The unique identifier for this mailing.

mailedFromIdstring

The documentId of the mailed document.

statusenum
Allowed values: CREATEDPROCESSING_FOR_DELIVERYIN_TRANSITDELIVEREDRETURNED_TO_SENDER

The status of the mailing.

toobject

The mailing address of the recipient.

urlstring

The URL to the mailed document.

userIdstringOptional

The unique identifier for a single end-user of your application.

Errors

Built with