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: [email protected]#$%^&*?|
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”.

[{
"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"
 }
}
]