{"api":"esign_rest","category":"reference"}

Users Category

Use the Users category to manage the users in your accounts.

You can:

  • Set custom user settings.
  • Manage a users profile.
  • Add delete users.
  • Add and delete the intials and signature images for a user.

UserCustomSettings

Users' custom settings

MethodDescription
list
GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings

Retrieves the custom user settings for a specified user.

update
PUT /v2.1/accounts/{accountId}/users/{userId}/custom_settings

Adds or updates custom user settings for the specified user.

delete
DELETE /v2.1/accounts/{accountId}/users/{userId}/custom_settings

Deletes custom user settings for a specified user.

UserProfiles

Users' profiles

MethodDescription
get
GET /v2.1/accounts/{accountId}/users/{userId}/profile

Retrieves the user profile for a specified user.

update
PUT /v2.1/accounts/{accountId}/users/{userId}/profile

Updates the user profile information for the specified user.

Users

The Users resource enables you to create and manage account users.

MethodDescription
list
GET /v2.1/accounts/{accountId}/users

Retrieves the list of users for the specified account.

updateList
PUT /v2.1/accounts/{accountId}/users

Changes one or more users in the specified account.

create
POST /v2.1/accounts/{accountId}/users

Adds new users to the specified account.

delete
DELETE /v2.1/accounts/{accountId}/users

Removes users account privileges.

get
GET /v2.1/accounts/{accountId}/users/{userId}

Gets the user information for a specified user.

update
PUT /v2.1/accounts/{accountId}/users/{userId}

Updates user information for the specified user.

getProfileImage
GET /v2.1/accounts/{accountId}/users/{userId}/profile/image

Retrieves the user profile image for the specified user.

updateProfileImage
PUT /v2.1/accounts/{accountId}/users/{userId}/profile/image

Updates the user profile image for a specified user.

deleteProfileImage
DELETE /v2.1/accounts/{accountId}/users/{userId}/profile/image

Deletes the user profile image for the specified user.

getSettings
GET /v2.1/accounts/{accountId}/users/{userId}/settings

Gets the user account settings for a specified user.

updateSettings
PUT /v2.1/accounts/{accountId}/users/{userId}/settings

Updates the user account settings for a specified user.

UserSignatures

Users' signatures

MethodDescription
list
GET /v2.1/accounts/{accountId}/users/{userId}/signatures

Retrieves a list of signature definitions for a user.

updateList
PUT /v2.1/accounts/{accountId}/users/{userId}/signatures

Adds/updates a user signature.

create
POST /v2.1/accounts/{accountId}/users/{userId}/signatures

Adds user Signature and initials images to a Signature.

get
GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}

Gets the user signature information for the specified user.

update
PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}

Updates the user signature for a specified user.

delete
DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}

Removes removes signature information for the specified user.

getImage
GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

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

updateImage
PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

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

deleteImage
DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

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

Contacts

The Contacts resource enables you to manage the contact in an account's address book.

MethodDescription
update
PUT /v2.1/accounts/{accountId}/contacts

Updates one or more contacts.

create
POST /v2.1/accounts/{accountId}/contacts

Imports new contacts into a contacts list.

deleteList
DELETE /v2.1/accounts/{accountId}/contacts

Deletes multiple contacts from an account.

get
GET /v2.1/accounts/{accountId}/contacts/{contactId}

Gets one or more contacts.

delete
DELETE /v2.1/accounts/{accountId}/contacts/{contactId}

Deletes a contact.

}} />