Mailrelay API Reference

Get sent campaign's unsubscribe events

GET /sent_campaigns/{id}/unsubscribe_events

Get sent campaign's unsubscribe events.

Pagination

This is a paginated resource. You can optionally send two query parameters:

Parameter Description
page The page that you want to retrieve. It starts with 1.
per_page The number of records returned per page. The max allowed value for this resource is 10000.

The response will include two HTTP headers:

Header Description
Total The total number of pages based on your parameters. You can use this option to know when you've reached the end of the pagination.
Per-Page The number of records returned per page.

Parameters

NameTypeDescription
id integer ID of the record
page integer Page number
per_page integer Number of records per page
q[email_eq] string Search: Email equals
q[email_cont] string Search: Email contains
q[sent_email_id_eq] integer Search: Sent email equals
q[sent_email_id_gteq] integer Search: Sent email greater than or equal to
q[sent_email_id_lteq] integer Search: Sent email less than or equal to
q[source_eq] string Search: Source equals
q[source_cont] string Search: Source contains
q[s] string Allows ordering the records based on a specific field. You may optionally append "asc" or "desc" to define the direction. Example: "email desc"

Responses

StatusDescription
200 Success
401 The API key wasn't sent or is invalid
500 An internal error happened. Try again later.
404 Couldn't find record with provided ID.