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

Create New User

Create a new user 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
user_id	john1970	Required
user_password	1959caadac9b13dcb3	Required if not included in the headers
type	user_new	Required
account_id	greatwidgets	Required
user_name	janeclerk	Required
user_new_password	pa$$wo0rd	Required
user_first_name	Jane	Optional
user_last_name	Doe	Optional
user_custom1	Melbourne Office	Optional
user_PIN	1234	Optional
language_selector	EN	Optional
timezone_selector	68	Optional
user_role	K	Required
allowed_campaigns	all or campaign id(s) or none	Required

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.
The user_name cannot be longer than 20 characters and must contain only alphanumeric characters and the underscore (" _ ")
The user_PIN is an API-specific field made available for custom applications such as a physical terminal. It cannot be defined or edited in the web interface. It MUST be unique to each user within an account.
You can find a list of language two-letter codes in the Available Languages reference page
You can find a list of timezone codes in the Timezones reference page
The allowed_campaigns consists of (see examples below) :
- A single entry "all"
- A single entry "none"
- Multiple entries of campaign IDs separated by a comma ","
- Administrator (A) users are not affected by this parameter and are always set to access all campaigns.
The user_role is based on the roles listed in the User Permission Levels reference page.
The user_custom1 field is shown on the Dashboard as "Location" and on XML results from the API as the <user_addtl_info> tag.

Example PHP Request:

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

$data['user_id'] = 'john1970';
$data['user_password'] = '1959caadac9b13dcb3';
$data['type'] = 'user_new';
$data['account_id'] = 'greatwidgets';
$data['user_name'] = 'janeclerk';
$data['user_new_password'] = 'pa$$w0rd';
$data['user_first_name'] = 'Jane';
$data['user_last_name'] = 'Doe';
$data['user_custom1'] = 'Melbourne Office';
$data['language_selector'] = 'EN';
$data['timezone_selector'] = '68';
$data['user_role'] = 'K';
$data['allowed_campaigns'] = '12971184024723,0239471023412';
or
$data['allowed_campaigns'] = 'all';
or
$data['allowed_campaigns'] = 'none';

Success XML Response (New / Updated User):

<response status="success">
</response>

Error XML Response:

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