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

BulkOperations Category

Methods to import and export users and accounts.

AccountExport

Methods and objects to get account information.

MethodDescription
getAccountSettingsExports
GET /v2/organizations/{organizationId}/exports/account_settings

Returns a list of pending and completed account settings export request.

createAccountSettingsExport
POST /v2/organizations/{organizationId}/exports/account_settings

Creates a new account settings export request.

getAccountSettingsExport
GET /v2/organizations/{organizationId}/exports/account_settings/{exportId}

Returns the results for a single account settings export request.

deleteAccountSettingsExport
DELETE /v2/organizations/{organizationId}/exports/account_settings/{exportId}

Deletes a single account settings export request. Any data associated with the request is also deleted.

UserExport

Methods for exporting a user list.

MethodDescription
getUserListExports
GET /v2/organizations/{organizationId}/exports/user_list

Returns a list of pending and completed export requests.

createUserListExport
POST /v2/organizations/{organizationId}/exports/user_list

Create a user list export request.

getUserListExport
GET /v2/organizations/{organizationId}/exports/user_list/{exportId}

Returns the results for single user list export request.

deleteUserListExport
DELETE /v2/organizations/{organizationId}/exports/user_list/{exportId}

Deletes a single user list export request.

UserImport

User import operations.

MethodDescription
addBulkUserImport
POST /v2/organizations/{organizationId}/imports/bulk_users/add

Creates a request to import new users into an account.

updateBulkUserImports
POST /v2/organizations/{organizationId}/imports/bulk_users/update

Bulk updates information of existing users.

closeBulkUserImportRequest
POST /v2/organizations/{organizationId}/imports/bulk_users/close

Creates a request to close the accounts of existing users.

getBulkUserImportRequests
GET /v2/organizations/{organizationId}/imports/bulk_users

Gets a list of all of the user import requests.

getBulkUserImportRequest
GET /v2/organizations/{organizationId}/imports/bulk_users/{importId}

Returns the details of a single user import request.

deleteBulkUserImport
DELETE /v2/organizations/{organizationId}/imports/bulk_users/{importId}

Deletes a specific user import request

getBulkUserImportCSV
GET /v2/organizations/{organizationId}/imports/bulk_users/{importId}/results_csv

Given the ID of a user import request, return the CSV file that was imported.

}} />