Userspecs Overview

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	Required/Optional	Data Type	Description
userType	Required	String	Value must be "Marketing" or "Sales".
email	Required	String	Email Address of the new user
firstName	Required	String	First name of the user
lastName	Required	String	Last name of the user
password	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	Optional	String	User's Job Title
phoneNumber	Optional	String	User's phone number
mobileNumber	Optional	String	User's cell number
timeZone	Optional	String	User's time zone
sendEmailConfirmation	Optional	String	Default is "No". Value of "Yes" causes a confirmation email to be sent to the user being created.
marketingPrivileges:launchPrivilege	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	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	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	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	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	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	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	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	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	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	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”. 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”.

[{
"userType":"Marketing",
"email":"[email protected]",
"firstName":"Elmer",
"lastName":"Fudd",
"password":"pwxxx123",
"title":"Marketing Manager",
"phoneNumber":"111-111-1111",
"mobileNumber":"222-222-2222",
"faxNumber":"333-333-3333",
"timeZone":"PT",
"sendEmailConfirmation":"Y"
},
{
"userType":"Sales",
"email":"[email protected]",
"firstName":"Bugs",
"lastName":"Bunny",
"password":"pwyyy456",
"title":"Sales Manager",
"phoneNumber":"444-444-4444",
"mobileNumber":"555-555-5555",
"faxNumber":"666-666-6666",
"timeZone":"PT",
"sendEmailConfirmation":"N",
"marketingPrivileges":{
 "launchPrivilege":"Not Allowed",
 "admin":"Y"
 },
 "contactLists":{
 "create":"Y",
 "delete":"N",
 "download":"Y"
 },
 "content":{
 "create":"Y",
 "delete":"N"
 },
 "programs":{
 "create":"Y",
 "delete":"N"
 },
 "accountWideEmail":{
 "view":"Y",
 "manage":"Y"
 }
}
]