Unsubscribers

Allows to retrieve email addresses that are a part of a global unsubscribe list of a particular brand.

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

Rate Limit

This endpoint is subject to the general API rate limit of 50 requests per 10 seconds. Learn more about handling rate limits.

Notes

  • This function supports a maximum of 10 calls in parallel
  • A maximum page size of 10 thousand (10,000) results is allowed. To request subsequent pages of results, repeat the request with the additional parameter $skip=n where n is the number of resulting records of the entire result set to skip over when returning the current page.
  • StartDate and EndDate refers to the date range when an unsubscribe email was created (inclusive)
  • If StartDate and EndDate are not provided the response will include the entire list
  • StartDate and EndDate parameters must be formatted exactly as depicted above
  • All times are returned in UTC

Sample Request

https://apiX.optimove.net/current/optimail/GetUnsubscribers?BrandID=4&StartDate=2020-03-16&EndDate=2020-03-17

Sample Response

[
  {"Email":"[email protected]", "UnsubscribedTime":2020-03-16 08:00:00},
  {"Email":"[email protected]", "UnsubscribedTime":2020-03-17 08:00:00}
]
Query Params
int32
required
string
string
int32
Defaults to 10000
int32
Defaults to 0
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json