Manage Opt-Out Lists

GET

/api.cgi?action=manage_optoutlists

curl --request GET \
  --url 'https://one.optizmo.net/api.cgi?ref=pqmpg&onid=662b824d577c74b57bf1c4fc647b79c7&advertiser_id=C12412&advertiser_name=BlockBuster&check_hash=7583f2e660997b8d1c224a8d74260c51&iframe=1&return_format=csv&action=manage_optoutlists%3Fref%3Dpqmpg'

• O.N.E API server

Signs the user into SUPPRESS, scoped to the advertiser, and opens the Opt-Out Lists page where the advertiser creates and manages its lists. This is the version 2 workflow: lists are created here, and your platform then offers them for selection through Get Opt-Out Lists. Version 1 platforms create lists through client_sync instead.

The advertiser is created first if it does not exist. The response is a redirect into SUPPRESS; open it in an iframe (send iframe=1) or a new window.

Values in the check_hash

action, ref, onid, advertiser_id, advertiser_name.

Failures

The common failures listed under Sync an advertiser, list, campaign and affiliate, for creating the advertiser.

Parameters

Query Parameters

ref

required

string

<= 5 characters

Your tracking platform’s Reference Code (PRC), issued by Optizmo when the integration was set up.

Example

pqmpg

onid

required

string

The ONID of the SUPPRESS account the request is for. The account holder finds it on the Account Settings page in SUPPRESS under Affiliate Tracking System, and copies it into your platform.

Example

662b824d577c74b57bf1c4fc647b79c7

advertiser_id

required

string

<= 40 characters

Your platform’s id for the advertiser. The advertiser is matched on this id within the account. On an Enterprise account (a single advertiser) the account itself is the advertiser and this id is not used for matching, but it is still required and hashed.

Example

C12412

advertiser_name

required

string

<= 80 characters

Name of the advertiser. Creates the advertiser on first sight and renames it when the name changes. Longer values are truncated.

Example

BlockBuster

check_hash

required

string

/^[0-9a-f]{32}$/

MD5 hex digest of the request’s hashed values, in the order they are listed for this action, followed by your Access Key (PAK). See Authentication for the rules.

Example

7583f2e660997b8d1c224a8d74260c51

advertiser_email

string

<= 80 characters

Contact email stored on the advertiser. Not hashed.

advertiser_phone

string

<= 20 characters

Contact phone number stored on the advertiser. Not hashed.

advertiser_contact

string

<= 70 characters

Contact name stored on the advertiser. Not hashed.

iframe

integer

Allowed values: 1

Set to 1 when the page is shown inside an iframe in your platform. Not hashed.

return_format

string

default: csv

Allowed values: csv xml json

Sets the format of the success or failed answer on the synchronisation and status actions, and of the failure answer on every action. It does not change the success answer of the report and list actions, which is always their own XML document, or of the actions that answer with a page or a redirect. csv, xml and json are the only recognised values; anything else is answered in the csv format, the default. Not included in the check_hash.

Responses

200

A failure in the format selected by return_format, or a sign-in page for browsers that block third-party cookies.

string

Example

failed,Check Hash Failed.

string

302

Redirect to the Opt-Out Lists page in SUPPRESS, signed in.

Headers

Location

string format: uri

503

The system is in maintenance mode. Retry later. The answer follows return_format: csv (also the answer to a return_format that is neither xml nor json) as text/plain, xml as text/xml, json as application/json.

string

Example

failed,System currently under maintenance

string

Example

<?xml version="1.0" encoding="utf-8"?>
<output><result>failed</result>
<error>System currently under maintenance</error></output>

object

output

object

result

required

string

Allowed values: success failed

data

Present when result is success. This action issues no keys, so both values are null.

object

mailer_url

string

nullable

optout_url

string

nullable

error

Present when result is failed.

string

Example

{
  "output": {
    "result": "failed",
    "error": "System currently under maintenance"
  }
}