Rokt Documentation
  • Documentation
  • User Guide
  • SDK
  • API
  • Third-Party Integrations
  • Help

›Unsubscribes

Overview

  • Introduction

Getting started

  • Glossary

Administration

  • Account settings
  • User management
  • Billing - Rokt Acquire

    • Billing & payment for campaigns
    • Invoicing & payment for monetization
    • Financial responsibility assignment
    • Agency commission setup

    Billing - Rokt Commerce

    • Billing & payment for campaigns
    • Invoicing & Payment for monetization

Campaigns

  • Creating campaigns
  • Editing campaigns
  • Pausing campaigns
  • Campaign status guide
  • Campaigns best practices
  • Audiences

    • Creating audiences
    • Editing audiences
    • Pausing audiences
    • Bid price
    • Attribute targeting

    Creatives

    • Building creatives
    • Editing creatives
    • Pausing creatives
    • Linking creatives to audiences
    • Effective creative copywriting

    Nurture

    • Creating Nurture Journeys
    • Creating emails

    Coupons

    • Sending coupon codes
    • Adding coupon codes
    • Replacing coupon codes

    Campaign policies

    • Policy overview
    • Quality consent
    • Transparency accuracy
    • Editorial requirements
    • Prohibited content
    • Social & ethical appropriateness
    • Compliance industry codes & regulations
    • Target audiences & restricted campaign content

Transaction

    Pages

    • Pages

    Placements

    • Placements

    Controls

    • Campaign & marketplace controls
    • Brand & vertical block rules
    • Minimum Quality Score setup
    • Advertiser vertical & sub-vertical breakdown

    Audiences

    • Audience targeting

Rokt Calendar

  • Overview
  • Integration guide
  • UTM tracking

Reporting & measurement

    Performance - Rokt Acquire

    • Conversion attribution
    • Campaign performance graphs

    Performance - Rokt Commerce

    • Transactions Dashboard

Data integrations

    Events

    • Import via Rokt SFTP
    • Import via measurement providers
    • Manual import

    Referrals

    • Overview
    • Export via API
    • Export via Rokt SFTP
    • Export via client SFTP
    • Export via email
    • Export via Mailchimp
    • Export via Sailthru
    • Export via Zapier
    • Manual export

    Transactions

    • Overview
    • Export via API
    • Export via Rokt SFTP
    • Export via client SFTP
    • Export via email
    • Manual export

    Custom audiences

    • Overview
    • Import via Rokt SFTP
    • Import via CSV (email)
    • Import via CSV (ZIP code)
    • Import via Mailchimp
    • Import via Zapier

    Unsubscribes

    • Export via API

    Advanced guides

    • Rokt SFTP setup
    • Rokt Tracking ID for attribution
    • Tracking application installs
    • Rokt IP addresses
    • Hashing sensitive data
    • Custom field management
    • Managing templates
    • Google Tag Manager integration
Edit

Unsubscribe export via API

API setups can range from easy plug-and-play integrations, to advanced two-phase integrations with custom field mapping. Regardless, given the intricacies of One Platform and the sensitivity of these integrations, referral API setups should always be completed by the Rokt operations team.

Before you begin

Be sure you have all the required API setup information first 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

← Import via ZapierRokt SFTP setup →
  • Before you begin
  • Setting up the API Connection
  • Testing your API connection
  • Linking campaigns to your API connection
  • Unlinking campaigns from your API connection
RESOURCES
DocumentationUser GuideSDKAPIIntegration PartnersHelp
COMPANY
About UsContact UsCareersEngineering Blog
Rokt Documentation
Copyright © Rokt 2021 - All Rights Reserved