module:api/UsersApi

new module:api/UsersApi(apiClient)

Source:

api/UsersApi.js, line 41

Constructs a new UsersApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

_delete(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 74

Removes users account privileges.
This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions.

The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an errorDetails node with errorCode and message properties.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`_delete`	String
`userInfoList`	module:model/UserInfoList

callback

module:api/UsersApi~_deleteCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UsersResponse

create(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 136

Adds news user to the specified account.
Adds new users to your account. Set the userSettings property in the request to specify the actions the users can perform on the account.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`newUsersDefinition`	module:model/NewUsersDefinition

callback

module:api/UsersApi~createCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NewUsersSummary

createSignatures(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 216

Adds user Signature and initials images to a Signature.
Adds a user signature image and/or user initials image to the specified user.

The userId property specified in the endpoint must match the authenticated user's userId and the user must be a member of the account.

The rules and processes associated with this are:
If Content-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.
If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.

For each Image part, the Content-Disposition header has a "filename" value that is used to map to the signatureName and/or signatureInitials properties in the JSON to the image.

For example:
Content-Disposition: file; filename="Ron Test20121127083900"

If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.

The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.

If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`userSignaturesInformation`	module:model/UserSignaturesInformation

callback

module:api/UsersApi~createSignaturesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserSignaturesInformation

deleteContacts(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 342

Delete contacts associated with an account for the DocuSign service.
This method deletes multiple contacts associated with an account.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`contactModRequest`	module:model/ContactModRequest

callback

module:api/UsersApi~deleteContactsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ContactUpdateResponse

deleteContactWithId(accountId, contactId, callback)

Source:

api/UsersApi.js, line 282

Replaces a particular contact associated with an account for the DocuSign service.
This method deletes a contact associated with an account.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`contactId`	String	The unique identifier of a person in the contacts address book.
`callback`	module:api/UsersApi~deleteContactWithIdCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/ContactUpdateResponse`

deleteCustomSettings(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 414

Deletes custom user settings for a specified user.
Deletes the specified custom user settings for a single user.

###Deleting Grouped Custom User Settings###

If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of customer user settings.

If the extra header information is not included, only the custom user settings that were added without a group are deleted.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`customSettingsInformation`	module:model/CustomSettingsInformation

callback

module:api/UsersApi~deleteCustomSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomSettingsInformation

deleteProfileImage(accountId, userId, callback)

Source:

api/UsersApi.js, line 481

Deletes the user profile image for the specified user.
Deletes the user profile image from the specified user's profile.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`callback`	module:api/UsersApi~deleteProfileImageCallback	The callback function, accepting three arguments: error, data, response

deleteSignature(accountId, userId, signatureId, callback)

Source:

api/UsersApi.js, line 546

Removes removes signature information for the specified user.
Removes the signature information for the user.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

The signatureId accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`signatureId`	String	The ID of the signature being accessed.
`callback`	module:api/UsersApi~deleteSignatureCallback	The callback function, accepting three arguments: error, data, response

deleteSignatureImage(accountId, userId, signatureId, imageType, callback)

Source:

api/UsersApi.js, line 621

Deletes the user initials image or the user signature image for the specified user.
Deletes the specified initials image or signature image for the specified user.

The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`signatureId`	String	The ID of the signature being accessed.
`imageType`	String	One of signature_image or initials_image.
`callback`	module:api/UsersApi~deleteSignatureImageCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/UserSignature`

getContactById(accountId, contactId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 705

Gets a particular contact associated with the user's account.
This method returns one or more contacts
associated with a DocuSign account. You can also
retrieve contacts from connected cloud storage providers by using the
cloud_provider query parameter. By default,
contacts are retrieved from the DocuSign account's
default address book.

To return a specific contact, use the contactId
query parameter. To return all contacts associated
with an account, omit this parameter.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

contactId

String

The unique identifier of a person in the contacts address book.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`cloudProvider`	String

callback

module:api/UsersApi~getContactByIdCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ContactGetResponse

getInformation(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 777

Gets the user information for a specified user.
Retrieves the user information for the specified user.

To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional additional_info query string parameter to true.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`additionalInfo`	String	When set to true, the full list of user information is returned for each user in the account.
`email`	String

callback

module:api/UsersApi~getInformationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserInformation

getProfile(accountId, userId, callback)

Source:

api/UsersApi.js, line 847

Retrieves the user profile for a specified user.
Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`callback`	module:api/UsersApi~getProfileCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/UserProfile`

getProfileImage(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 912

Retrieves the user profile image for the specified user.
Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.

If successful, the response returns a 200 - OK and the user profile image.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`encoding`	String

callback

module:api/UsersApi~getProfileImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: Object

getSettings(accountId, userId, callback)

Source:

api/UsersApi.js, line 981

Gets the user account settings for a specified user.
Retrieves a list of the account settings and email notification information for the specified user.

The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`callback`	module:api/UsersApi~getSettingsCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/UserSettingsInformation`

getSignature(accountId, userId, signatureId, callback)

Source:

api/UsersApi.js, line 1047

Gets the user signature information for the specified user.
Retrieves the structure of a single signature with a known signature name.

The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`signatureId`	String	The ID of the signature being accessed.
`callback`	module:api/UsersApi~getSignatureCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/UserSignature`

getSignatureImage(accountId, userId, signatureId, imageType, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1124

Retrieves the user initials image or the user signature image for the specified user.
Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.

The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

For example encode "Bob Smith" as "Bob%20Smith".

Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

signatureId

String

The ID of the signature being accessed.

imageType

String

One of signature_image or initials_image.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`includeChrome`	String

callback

module:api/UsersApi~getSignatureImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: Object

list(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1218

Retrieves the list of users for the specified account.
Retrieves the list of users for the specified account.

The response returns the list of users for the account along with the information about the result set. If the additional_info query was added to the endpoint and set to true, the full user information is returned for each user

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`additionalInfo`	String	When set to true, the full list of user information is returned for each user in the account.
`alternateAdminsOnly`	String
`count`	String	Number of records to return. The number must be greater than 0 and less than or equal to 100.
`domainUsersOnly`	String
`email`	String
`emailSubstring`	String	Filters the returned user records by the email address or a sub-string of email address.
`groupId`	String	Filters user records returned by one or more group Id's.
`includeUsersettingsForCsv`	String
`loginStatus`	String
`notGroupId`	String
`startPosition`	String	Starting value for the list.
`status`	String
`userNameSubstring`	String	Filters the user records returned by the user name or a sub-string of user name.

callback

module:api/UsersApi~listCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserInformationList

listCustomSettings(accountId, userId, callback)

Source:

api/UsersApi.js, line 1305

Retrieves the custom user settings for a specified user.
Retrieves a list of custom user settings for a single user.

Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.

Note: Custom user settings are not the same as user account settings.

###Getting Grouped Custom User Settings###

If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of customer user settings.

If the extra header information is not included, only the custom user settings that were added without a group are retrieved.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`callback`	module:api/UsersApi~listCustomSettingsCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/CustomSettingsInformation`

listSignatures(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1372

Retrieves a list of user signature definitions for a specified user.
Retrieves the signature definitions for the specified user.

The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`stampType`	String

callback

module:api/UsersApi~listSignaturesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserSignaturesInformation

postContacts(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1440

Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
This method adds multiple contacts into a contacts list.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`contactModRequest`	module:model/ContactModRequest

callback

module:api/UsersApi~postContactsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ContactUpdateResponse

putContacts(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1501

Replaces contacts associated with an account for the DocuSign service.
This method updates one or more contacts associated with an account.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`contactModRequest`	module:model/ContactModRequest

callback

module:api/UsersApi~putContactsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ContactUpdateResponse

updateCustomSettings(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1583

Adds or updates custom user settings for the specified user.
Adds or updates custom user settings for the specified user.

Note: Custom user settings are not the same as user account settings.

Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.
Important*: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.

Grouping Custom User Settings

You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.

To group custom user settings, add the following information in the header, after Content-Type:

X-DocuSign-User-Settings-Key:group_name

Where the group_name is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.

When getting or deleting grouped custom user settings, you must include the extra header information.

Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`customSettingsInformation`	module:model/CustomSettingsInformation

callback

module:api/UsersApi~updateCustomSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomSettingsInformation

updateProfile(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1652

Updates the user profile information for the specified user.
Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.

You can also change a user's name by changing the information in the userDetails property. When changing a user's name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence over changes to the userName property.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`userProfile`	module:model/UserProfile

callback

module:api/UsersApi~updateProfileCallback

The callback function, accepting three arguments: error, data, response

updateProfileImage(accountId, userId, callback)

Source:

api/UsersApi.js, line 1719

Updates the user profile image for a specified user.
Updates the user profile image by uploading an image to the user profile.

The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`userId`	String	The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
`callback`	module:api/UsersApi~updateProfileImageCallback	The callback function, accepting three arguments: error, data, response

updateSettings(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1780

Updates the user account settings for a specified user.
Updates the account settings list and email notification types for the specified user.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`allowAllLanguages`	String
`userSettingsInformation`	module:model/UserSettingsInformation

callback

module:api/UsersApi~updateSettingsCallback

The callback function, accepting three arguments: error, data, response

updateSignature(accountId, userId, signatureId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1859

Updates the user signature for a specified user.
Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.

Note: This will also create a default signature for the user when one does not exist.

The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

signatureId

String

The ID of the signature being accessed.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`closeExistingSignature`	String	When set to true, closes the current signature.
`userSignatureDefinition`	module:model/UserSignatureDefinition

callback

module:api/UsersApi~updateSignatureCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserSignature

updateSignatureImage(accountId, userId, signatureId, imageType, imageBytes, optsOrCallback, callback)

Source:

api/UsersApi.js, line 1944

Updates the user signature image or user initials image for the specified user.
Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.

The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

For example encode "Bob Smith" as "Bob%20Smith".

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

signatureId

String

The ID of the signature being accessed.

imageType

String

One of signature_image or initials_image.

imageBytes

Blob

Updated image content.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`transparentPng`	String

callback

module:api/UsersApi~updateSignatureImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserSignature

updateSignatures(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 2030

Adds/updates a user signature.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`userSignaturesInformation`	module:model/UserSignaturesInformation

callback

module:api/UsersApi~updateSignaturesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserSignaturesInformation

updateUser(accountId, userId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 2099

Updates the specified user information.
To update user information for a specific user, submit a Users object with updated field values in the request body of this operation.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

userId

String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`allowAllLanguages`	String
`userInformation`	module:model/UserInformation

callback

module:api/UsersApi~updateUserCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserInformation

updateUsers(accountId, optsOrCallback, callback)

Source:

api/UsersApi.js, line 2168

Change one or more user in the specified account.
This method updates the information about one or more account users.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`allowAllLanguages`	String
`userInformationList`	module:model/UserInformationList

callback

module:api/UsersApi~updateUsersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserInformationList

Type Definitions

_deleteCallback(error, data, If)

Source:

api/UsersApi.js, line 54

(Optional) Callback function to receive the result of the _delete operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UsersResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createCallback(error, data, If)

Source:

api/UsersApi.js, line 119

(Optional) Callback function to receive the result of the create operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/NewUsersSummary	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createSignaturesCallback(error, data, If)

Source:

api/UsersApi.js, line 180

(Optional) Callback function to receive the result of the createSignatures operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignaturesInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteContactsCallback(error, data, If)

Source:

api/UsersApi.js, line 325

(Optional) Callback function to receive the result of the deleteContacts operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ContactUpdateResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteContactWithIdCallback(error, data, If)

Source:

api/UsersApi.js, line 266

(Optional) Callback function to receive the result of the deleteContactWithId operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ContactUpdateResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteCustomSettingsCallback(error, data, If)

Source:

api/UsersApi.js, line 386

(Optional) Callback function to receive the result of the deleteCustomSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CustomSettingsInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteProfileImageCallback(error, data, If)

Source:

api/UsersApi.js, line 464

(Optional) Callback function to receive the result of the deleteProfileImage operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteSignatureCallback(error, data, If)

Source:

api/UsersApi.js, line 524

(Optional) Callback function to receive the result of the deleteSignature operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteSignatureImageCallback(error, data, If)

Source:

api/UsersApi.js, line 595

(Optional) Callback function to receive the result of the deleteSignatureImage operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignature	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getContactByIdCallback(error, data, If)

Source:

api/UsersApi.js, line 676

(Optional) Callback function to receive the result of the getContactById operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ContactGetResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getInformationCallback(error, data, If)

Source:

api/UsersApi.js, line 756

(Optional) Callback function to receive the result of the getInformation operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getProfileCallback(error, data, If)

Source:

api/UsersApi.js, line 829

(Optional) Callback function to receive the result of the getProfile operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserProfile	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getProfileImageCallback(error, data, If)

Source:

api/UsersApi.js, line 890

(Optional) Callback function to receive the result of the getProfileImage operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Object	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getSettingsCallback(error, data, If)

Source:

api/UsersApi.js, line 963

(Optional) Callback function to receive the result of the getSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSettingsInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getSignatureCallback(error, data, If)

Source:

api/UsersApi.js, line 1024

(Optional) Callback function to receive the result of the getSignature operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignature	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getSignatureImageCallback(error, data, If)

Source:

api/UsersApi.js, line 1096

(Optional) Callback function to receive the result of the getSignatureImage operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Object	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCallback(error, data, If)

Source:

api/UsersApi.js, line 1187

(Optional) Callback function to receive the result of the list operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserInformationList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCustomSettingsCallback(error, data, If)

Source:

api/UsersApi.js, line 1275

(Optional) Callback function to receive the result of the listCustomSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CustomSettingsInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listSignaturesCallback(error, data, If)

Source:

api/UsersApi.js, line 1348

(Optional) Callback function to receive the result of the listSignatures operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignaturesInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

postContactsCallback(error, data, If)

Source:

api/UsersApi.js, line 1423

(Optional) Callback function to receive the result of the postContacts operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ContactUpdateResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

putContactsCallback(error, data, If)

Source:

api/UsersApi.js, line 1484

(Optional) Callback function to receive the result of the putContacts operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/ContactUpdateResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateCustomSettingsCallback(error, data, If)

Source:

api/UsersApi.js, line 1545

(Optional) Callback function to receive the result of the updateCustomSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/CustomSettingsInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateProfileCallback(error, data, If)

Source:

api/UsersApi.js, line 1633

(Optional) Callback function to receive the result of the updateProfile operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateProfileImageCallback(error, data, If)

Source:

api/UsersApi.js, line 1702

(Optional) Callback function to receive the result of the updateProfileImage operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSettingsCallback(error, data, If)

Source:

api/UsersApi.js, line 1762

(Optional) Callback function to receive the result of the updateSettings operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSignatureCallback(error, data, If)

Source:

api/UsersApi.js, line 1831

(Optional) Callback function to receive the result of the updateSignature operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignature	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSignatureImageCallback(error, data, If)

Source:

api/UsersApi.js, line 1916

(Optional) Callback function to receive the result of the updateSignatureImage operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignature	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSignaturesCallback(error, data, If)

Source:

api/UsersApi.js, line 2012

(Optional) Callback function to receive the result of the updateSignatures operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserSignaturesInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateUserCallback(error, data, If)

Source:

api/UsersApi.js, line 2080

(Optional) Callback function to receive the result of the updateUser operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserInformation	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateUsersCallback(error, data, If)

Source:

api/UsersApi.js, line 2150

(Optional) Callback function to receive the result of the updateUsers operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UserInformationList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.