API Documentation

API DOCUMENTATION

Last Update: July 2025



Premiere Access Enterprise-Level API Calls API Calls Overview Clients (Businesses) Account - Update Account - Info Dashboard - Info Custom Fields Customer Field - Create Customer Fields - List Customer Field - Update Customer Field - Delete Transaction Field - Create Transaction Fields - List Transaction Field - Update Transaction Field - Delete Reward Custom Field - Create Reward Custom Fields - List Reward Custom Field - Update Reward Custom Field - Delete Users (Business Employees) User - New User - Update Users - List User - Info User - Delete Users - Add to Campaign Users - Rem. from Campaign Loyalty Programs Campaign - New Campaign Campaign - New Reward Campaign - New Promo Campaign - New BuyX Item Campaign - New Depreciation Campaign - New Fee Campaign - Update Campaign Campaign - Update Reward Campaign - Update Promo Campaign - Update BuyX Item Campaign - Update Depreciation Campaign - Update Fee Campaign - List Campaigns Campaign - List Deactivated Campaign - List Rewards Campaign - List Promotions Campaign - List Depreciations Campaign - List Fees Campaign - List BuyX Items Campaign - Delete Campaign Campaign - Delete Reward Campaign - Delete Promo Campaign - Delete BuyX Item Campaign - Delete Depreciation Campaign - Delete Fee Campaign - Deactivate Campaign - Reactivate Customers Customer - New/Register Customer - Update Customer - Generate Card # Customer - Batch Customer - Search Customer - Find Customer - Information Customer - Exists Customer - Balance & History Customer - Delete Customer - Validate Card Replace Transactions Transaction - Record Transaction - Redeem Transaction - Batch Transaction - Delete Misc. Calls: Token - Get Token - Validate Audit Reports All Transactions All Redeemed Transactions Campaign Totals Customer Balances Marketing Reports All Customers New Customers Frequent Customers Missing Customers Birthdays Custom Date Range Customer Search Reference Currency Codes Country Codes Timezones Available Languages User Permission Levels Replacement Codes Premium APIs Email Templates Email Template - New Email Template - Update Email Template - Information Email Templates - List Email Template - Delete SMS Templates SMS List Service Providers SMS Add Credentials SMS Update Credentials SMS Template - New SMS Template - Update SMS Template - Information SMS Templates - List SMS Template - Delete Memberships Membership Program - New Membership Program - Update Membership Program - Info Membership Programs - List Membership Program - Delete Membership Level - New Membership Level - Update Membership Level - Info Membership Levels - List Membership Level - Delete Boost Promos Fixed Boost - New Fixed Boost - Update Temporary Boost - New Temporary Boost - Update Recurring Boost - New Recurring Boost - Update Boost - Info Boost - List Boost - Delete

Deactivated (on hold) Campaigns List

Returns a list of the deactivated campaigns for an account.

Headers

		Key		Value		Note
		api_access_key		user_api_key		Optional

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959caadac9b13dcb3	Required if not included in the headers
account_id	greatwidgets	Required
type	campaigns_inactive_list	Required

type_restrict	points, giftcard, events, earned, buyx	Optional

searchField	campaign_name or campaign_type	Optional
searchOper	eq (equal) ne (not equal) bw (begins with) bn (does not begin with) ew (ends with) en (does not end with) cn (contains) nc (does not contain) nu (is null/empty) nn (is not null/empty) in (is in - comma-separated list) ni (is not in - comma-separated list)	Optional
searchValue	London	Optional

sortField	campaign_name or campaign_type	Optional
sortOrder	DESC or ASC	Optional

offset	0	Optional
length	10	Optional

Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Notes:

Headers: the user_api_key value can be included in either the header section or the body of the request. If the key is provided in both locations, the API will process and validate only the value provided in the headers.
When using this call, the list of deactivated campaigns returned is based on the permissions of the user_id that is making the call. Only manager-level users can make this call.
The type_restrict parameter is optional, and can be combined with the searchField. If it's not given, all campaign types are returned. If you want multiple campaign types, list each type separated by a comma, which makes it slightly different than achieving the same thing using searchField=campaign_type, which is restricted to a single campaign type.

Example PHP Request:

If you are using PHP, the $data array would look like this:

$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['type'] = 'campaigns_inactive_list';
$data['account_id'] = 'greatwidgets';

Success XML Response:

<response status="success">
<campaigns>
<campaign>
<id>1234567890123456</id>
<name>Widget Rewards</name>
<type>points</type>
<points_ratio>5</points_ratio>
<reward_ratio>15</reward_ratio>
</campaign>
<campaign>
<id>2345678901234567</id>
<name>Sales Bucks</name>
<type>earned</type>
<earned_per_event>4.95</earned_per_event>
</campaign>
<campaign>
<id>3456789012345678</id>
<name>Frequent Shopper Rewards</name>
<type>buyx</type>
<item>
<id>45678</id>
<description>Coffees and Teas</description>
<earn_ratio>10</earn_ratio>
...
</item>
</campaign>
...
</campaign>
</response>

Notes:
There are 5 campaign types:

points (Points-based campaigns)
giftcard (Currency-based campaigns)
events (Event-based campaigns
earned (Currency earned per event campaigns)
buyx (Buy X Get 1 Free type campaigns)

Gift Card and events-based campaigns do not have ratios to report.

Example PHP request to list ONLY Gift Cards and Points deactivated campaigns:

If you are using PHP, the $data array would look like this:

$data['API'] = '1.5';
$data['user_id'] = 'john1970';
$data['user_api_key'] = '1959caadac9b13dcb3';
$data['type'] = 'campaigns_inactive_list';
$data['account_id'] = 'greatwidgets';
$data['type_restrict2'] = 'giftcard, points';

Success XML Response:

<response status="success">
<campaign>
<id>2345678901234567</id>
<name>My Stored Value Card</name>
<type>giftcard</type>
</campaign>
<campaign>
<id>1234567890123456</id>
<name>Widget Rewards</name>
<type>points</type>
<points_ratio>5</points_ratio>
<reward_ratio>15</reward_ratio>
</campaign>
...
</campaign>
</response>

Error XML Response:

<response status="error">
<error>Error message</error>
</response>