Request Opt-Out List

Introduction

The opt-out list for a particular email type is a list of all email addresses that have been explicitly unsubscribed from that email type.

Requesting email addresses is a two step process involving:

Request an opt-out list of encrypted emails
Decrypt the emails from step #1.

This page documents step 1. For step 2 refer to Decrypting Email Addresses.

Refer to the Tools page to view Open API specs and Postman collections that help you interact with the Notifications Subscriptions API.

Request

GET https://[stg.]api.bazaarvoice.com/notifications/<client-name>/subscriptions/by_page/<email-type>/OPT_OUT?passkey=<your-api-key>&limit=<limit-value>&offset=<offset-token> HTTP/1.1

Returns a paginated list of encrypted email addresses that have been added to the opt-out list for a particular email type.

Each response will include an offset value. This value should be used in subsequent requests. Continue making requests until no more email addresses are returned.

Parameters

All parameters are required, unless otherwise noted.

Name	Description
Path
`[stg.]`	Optional. Use to make request in a non-production context. Refer to Environments to learn more.
`<client-name>`	Lower case customer name associated with your API key. Look this up in Bazaarvoice Portal.
`<email-type>`	Capitalized email type. See Notification Types.
Query String
`passkey`	Your public API key. Look this up in Bazaarvoice Portal.
`limit`	Optional. Count of email address to return. Max value of 1000 is supported. Default is 1000.
`offset`	Required after 1st request. A token, provided in each API response, to be used in the next request.

Response

The response to a successful request will be a JSON array of encrypted email address. The following demonstrates a typical response:

{
  "offset": "NTkwNDdhNmEyODgyMmNhMWYwM2Q1Mzk3",
  "data": [
    {
      "emailAddress": "ae539bf4af00a1a9c0134671d88bba334778d63a2555d0d7f1e1588aa384091f",
      "timestamp": "2017-01-06T16:47:15.082Z"
    },
    {
      "emailAddress": "e915fa9015ad9ccee4afd10fa95565334778d63a2555d0d7f1e1588aa384091f",
      "timestamp": "2017-01-06T16:47:15.082Z"
    },
    …
  ]
}

Properties

Name	Description
`offset`	Used to request the next set of email addresses. See the Parameters section above more more information.
`emailAddress`	An encrypted email address. Refer to Decrypting Email Addresses to learn how reverse the encryption.
`timestamp`	When the email address was added to the opt-in list.