Advertiser and list settings page

GET

/api.cgi?action=client_config

const url = 'https://one.optizmo.net/api.cgi?ref=pqmpg&onid=662b824d577c74b57bf1c4fc647b79c7&advertiser_id=C12412&advertiser_name=BlockBuster&optout_id=O39232&optout_name=Master%20List&campaign_id=K3K3&campaign_name=Spring%20Offer&check_hash=7583f2e660997b8d1c224a8d74260c51&s=advertiser&optout_set_md5only=1&return_format=csv&test_only=success&action=client_config%3Fref%3Dpqmpg';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://one.optizmo.net/api.cgi?ref=pqmpg&onid=662b824d577c74b57bf1c4fc647b79c7&advertiser_id=C12412&advertiser_name=BlockBuster&optout_id=O39232&optout_name=Master%20List&campaign_id=K3K3&campaign_name=Spring%20Offer&check_hash=7583f2e660997b8d1c224a8d74260c51&s=advertiser&optout_set_md5only=1&return_format=csv&test_only=success&action=client_config%3Fref%3Dpqmpg'

Opens a SUPPRESS settings page for the advertiser, to be shown in an iframe or a new window from your platform. The advertiser (and the Opt-Out List, when optout_id is sent) is created first if it does not exist, exactly as Sync an advertiser, list, campaign and affiliate would.

The s parameter selects the page:

`s`	Page	Notes
omitted or `advertiser`	Advertiser settings: contact details, which file formats affiliates may download, the opt-out page.	Network accounts only. On an Enterprise account the default page is the list settings.
`optoutlist`	Opt-Out List settings for the list named by `optout_id`.	Requires `optout_id`.
`addEmails`	Upload a file of opt-outs into the list named by `optout_id`.	Requires `optout_id`. Also reachable as `action=add_emails`.

The response is an HTML page. Requests with an unknown s value answer failed,Invalid sub-action.

Values in the `check_hash`

In this order, skipping any parameter you do not send: action, ref, onid, advertiser_id, advertiser_name, optout_id, optout_name (version 1 only), campaign_id, campaign_name.

Failures

failed,Invalid sub-action above, and the common failures listed under Sync an advertiser, list, campaign and affiliate for creating the advertiser and the list.

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

optout_id

string

The Opt-Out List. Unlike the other ids, its length is not checked or truncated.

Version 1: your platform’s id for the list. The list is created in the advertiser on first sight and matched on this id afterwards.
Version 2: the optoutlist_id of a list the advertiser created in SUPPRESS, as returned by Get Opt-Out Lists. The list must exist.

Required when campaign_id is sent.

Examples

Version 1

O39232

Version 2

f3k93kda3

optout_name

string

Name of the Opt-Out List. Version 1 only: required whenever optout_id is sent; the list is renamed when the name changes. Version 2 platforms do not send it; if sent, it is ignored but still part of the check_hash.

Example

Master List

campaign_id

string

<= 40 characters

Your platform’s id for the campaign (offer). The campaign is created on the list named by optout_id on first sight and matched on this id within the advertiser afterwards. Requires optout_id. Sending an existing campaign with a different optout_id moves the campaign to that list; see Changing a campaign’s Opt-Out List.

Example

K3K3

campaign_name

string

<= 150 characters

Name of the campaign. Required when campaign_id is sent; the campaign is renamed when the name changes. Longer values are truncated.

Example

Spring Offer

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

string

Allowed values: advertiser optoutlist addEmails

The page to open. Not hashed.

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.

optout_set_md5only

integer

Allowed values: 1

Version 1 only. Set to 1 to create the list as an MD5-only list. Has no effect on an existing list. 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.

test_only

string

Allowed values: success failed

Only honoured by Sync an advertiser, list, campaign and affiliate, Sync onto a linked list, Generate an SMAK, Account report, Get Opt-Out Lists, Advertiser and list settings page and Add opt-outs page; every other action ignores it and runs as normal, so sending it there does not stop the real change. On the actions that honour it, once the request has authenticated, it answers without creating or changing anything, and before the page renders on the two pages actions: failed,Test Failed Output for test_only=failed everywhere it is honoured. For test_only=success: the sync actions return a fixed key pair (https://TESTONLY.optizmo.net/m-test-a00-410324axc3e1eb7a and https://TESTONLY.optoutsystem.net/o-test-a00-546c4dxa10df19b8) in place of real ones, in the same body shape a real success with keys would have; the account report returns that same fixed key pair, not a report document; Get Opt-Out Lists returns a fixed two-entry list document; and the two pages actions return a bare success with no keys, the same shape as a real one with no campaign_id/mailer_id pair. Not included in the check_hash.

Responses

200

The requested settings page, or a failure in the format selected by return_format.

string

Example

failed,Invalid sub-action

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"
  }
}

Advertiser and list settings page

Values in the check_hash

Failures

Parameters

Query Parameters

Example

Example

Example

Example

Examples

Example

Example

Example

Example

Responses

200

Example

503

Example

Example

Example

Values in the `check_hash`