Skip to main content

Unsubscribe export via API

If you have an unsubscribe API available through your CRM or customer database, Rokt can deliver the details on any customer that has unsubscribed from nurture messages. This ensures that you don't continue messaging any customers that may have opted out of communications with your brand.

caution

We recommend working with the Rokt operations team to set up the API connection. Reach out to support@rokt.com or your account manager.

If you would like to send Rokt information on any customers that may have unsubscribed from brand communications that you have sent, you can leverage Rokt's Unsubscribe API.

Before you begin#

Be sure you have all the required API setup information including the relevant environment endpoints, authentication method, and any required parameters.

Setting up the API connection#

  1. Navigate to your account in One Platform.

  2. From the left navigation, click Connections.

    Screenshot 1

  3. Click Add connection.

    Screenshot 1

  4. Under Unsubscribes, select API.

    Screenshot 2

  5. Give your connection a name.

    Screenshot 3

  6. Enter the endpoint for your connection.

    Screenshot 4

  7. Enter all required information under Authorization, Headers, and Body.

    Screenshot 5

  8. Enter your Response handling rules.

    Screenshot 6

Testing your API connection#

  1. Once your API connection is set up (endpoint, authorization, headers, body, and response handling), click Settings.

    Screenshot 7

  2. Edit the testing settings according to your test criteria.

    Screenshot 8

  3. Click Save.

  4. Click Test.

    Screenshot 10

  5. Check your test result.

  6. Repeat tests until you've achieved your desired outcomes.

Linking campaigns to your API connection#

  1. Go to the Connections page. From the dropdowns, select Real-time and Referrals.

  2. Expand the connection that you want to link a campaign to.

    Screenshot 11

  3. Click Show unlinked.

    Screenshot 12

  4. Find the campaign that you want to link to your connection and click Link.

    Screenshot 13

  5. The campaign is now linked to your connection.

    Screenshot 14

Unlinking campaigns from your API connection#

  1. Go to the Connections page. From the dropdowns, select Real-time and Referrals.

  2. Expand the connection that you want to unlink a campaign from.

    Screenshot 15

  3. Find the campaign that you want to unlink from your connection and click Unlink.

    Screenshot 16

  4. Click Show unlinked.

    Screenshot 17

  5. Confirm that the campaign is now unlinked from the connection.

    Screenshot 18

Was this article helpful?