userspecs

Userspecs is a JSON object to describe the users that are to be created. You pass the userspecs as a form parameter. The userspecs can contain any number of users to create. However, the each account has a maximum number of users that can be created.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
userType False Required String Value must be "Marketing" or "Sales".
email False Required String Email address of the new user.
firstName False Required String First name of the user.
lastName False Required String Last name of the user.
password False Required String Initial password for the user. The user will be required to change the password during the first login. Password must be between 6 and 30 characters long and contain only the following characters: a-zA-Z0-9!@#$%^&*?|
title False Optional String Title for the user. Example: "Marketing Manager".
phoneNumber False Optional String Phone number for the user.
mobileNumber False Optional String Mobile/Cell number for the user.
faxNumber False Optional String Fax number for the user.
timeZone False Optional String Time zone for the user.
sendEmailConfirmation False Optional String Default is "No". Value of "Yes" causes a confirmation email to be sent to the user being created.
marketingPrivileges:launchPrivilege False Optional String "Allowed" or "Not Allowed" to indicate if the user can launch the app. See Code Example for formatting requirements. The default is the same as it is in the UI.
marketingPrivileges:admin False Optional String "Y" or "N" to indicate if the user is an Administrator. See Code Example for formatting requirements. The default is the same as it is in the UI.
contactLists:create False Optional String "Y" or "N" to indicate if the user can create contact lists. See Code Example for formatting requirements. The default is the same as it is in the UI.
contactLists:delete False Optional String "Y" or "N" to indicate if the user can delete contact lists. See Code Example for formatting requirements. The default is the same as it is in the UI.
contactLists:download False Optional String "Y" or "N" to indicate if the user can download contact lists. See Code Example for formatting requirements. The default is the same as it is in the UI.
content:create False Optional String "Y" or "N" to indicate if the user can create content. See Code Example for formatting requirements. The default is the same as it is in the UI.
content:delete False Optional String "Y" or "N" to indicate if the user can delete content. See Code Example for formatting requirements. The default is the same as it is in the UI.
programs:create False Optional String "Y" or "N" to indicate if the user can create programs. See Code Example for formatting requirements. The default is the same as it is in the UI.
programs:delete False Optional String "Y" or "N" to indicate if the user can delete programs. See Code Example for formatting requirements. The default is the same as it is in the UI.
accountWideEmail:view False Optional String "Y" or "N" to indicate if the user can view account wide email. See Code Example for formatting requirements. The default is the same as it is in the UI.
accountWideEmail:manage False Optional String "Y" or "N" to indicate if the user can manage account wide email. See Code Example for formatting requirements. The default is the same as it is in the UI.

Code Examples

The userspecs is a JSON formatted representation of the users to create. In the parameter list above when an element is nested it is shown with a “:”. So, for example, the parameter “accountWideEmail:manage” means that the “manage” element is an element of “accountWideEmail”.

 

OAuth
Grant Type Password
Grant Type Code
Grant Type Refresh
Account API
Get account information
Create new account user
Delete account users
Delete account user
Get email senders
Fact API
Upload custom events
Get upload custom event status
List API
Get listing of lists
Download a list
Create a new list
Update or merge a list
Get list upload status
Get rejected records from an upload
Delete a list
Delete records from a list
Get hard bounce list
Get spam complaint list
Get optout list
Update optout list
Get subscription opt-outs by category
mergespecs
uploadspecs
Content API
Get logo list
Get a logo
Add a logo
Update a logo
Delete a logo
Get header list
Get a header
Add a header
Update a header
Delete a header
Get footer list
Get a footer
Add a new footer
Delete a footer
Update a footer
Get image list
Get an image
Add an image
Replace an image
Delete an image
Get media list
Get media file
Add a media file
Add a media link
Update Media File
Delete a media object
Get form list
Get promotional form URLs
Get page list
Get page
Delete page
Get promotional page URLs
Get list of programs
Reporting API
Get message report
Get message report drilldown
Get message report by time period
Get media report
Get media message report
Get a media view report
Get a media timeline report
Get form report
Get page report
Get spam complaint list
Get hard bounce list
Email Campaign API
Get message list
Send a message
Resend a message
Add new template or draft message
Update template or draft message
Delete a message
Get message report
Get message report drilldown
Get message report by time period
Get message HTML contents
Contact API
Add a contact
Get contact record
Upsert a contact record by email
Update a contact by record ID
Delete a contact
Get contact record ID based on cookie value
Get contact from list based on cookie ID or e-mail
Get contact fact and score data
Get subscription categories
Opt in/Opt out subscription category by email address
Get subscription category opt-ins by email
Opt in/Opt out multiple subscription categories by email address
SEO API
Get SEO keywords
Get a new SEO report
Frequently Asked Questions