API Reference

Receive unsubscribe events within a given time range, across both email and SMS channels.

get
https://api.ometria.com/v2/unsubscribes

Email

The following unsubscribe types are available via the endpoint:

Preferences centre

App

List unsubscribe — when the contact clicks the "unsubscribe" button in their email client.

Link unsubscribe — when the contact clicks a link formatted for Ometria to recognise.

SMS

Two types are available via the endpoint:

stopword_unsubscribe_TF — unsubscribe via a stop word in an automation campaign. stopword_unsubscribe_DO — unsubscribe via a stop word in double opt-in message.

Not available via the endpoint

API unsubscribes are not available through this endpoint, for either email or SMS.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The earliest date from which to fetch unsubscribe data. Following time format YYYY-MM-DDTH:I:S in UTC.

string

The latest date from which to fetch unsubscribe data. Following time format YYYY-MM-DDTH:I:S in UTC.

string

The type of unsubscribe event to return.

Responses

403

API key is not authorised to access this resource.

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago