Create New User

Create a new user for an account.

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

Notes:

• 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:

1. $data['user_id'] = 'john1970';
2. $data['user_password'] = '1959caadac9b13dcb3';
3. $data['type'] = 'user_new';
4. $data['account_id'] = 'greatwidgets';
5. $data['user_name'] = 'janeclerk';
6. $data['user_new_password'] = 'pa$$w0rd';
7. $data['user_first_name'] = 'Jane';
8. $data['user_last_name'] = 'Doe';
9. $data['user_custom1'] = 'Melbourne Office';
10. $data['language_selector'] = 'EN';
11. $data['timezone_selector'] = '68';
12. $data['user_role'] = 'K';
13. $data['allowed_campaigns'] = '12971184024723,0239471023412';
14. or
15. $data['allowed_campaigns'] = 'all';
16. or
17. $data['allowed_campaigns'] = 'none';

Success XML Response (New / Updated User):

1. <response status="success">
2. </response>

Error XML Response:

1. <response status="error">
2. <error>Error message</error>
3. </response>