Create request to close accounts of users

POST

/v2/organizations/:organizationId/imports/bulk_users/close

POST

/Management/v2/organizations/:organizationId/imports/bulk_users/close

curl -X POST https://api-d.docusign.net/Management/v2/organizations/organizationId/imports/bulk_users/close \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F file.csv=@string

200Successful

{
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "string",
  "requestor": {
    "name": "string",
    "id": "string",
    "type": "string",
    "email": "string"
  },
  "created": "2024-01-15T09:30:00Z",
  "last_modified": "2024-01-15T09:30:00Z",
  "status": "string",
  "user_count": 1,
  "processed_user_count": 1,
  "added_user_count": 1,
  "updated_user_count": 1,
  "closed_user_count": 1,
  "no_action_required_user_count": 1,
  "error_count": 1,
  "warning_count": 1,
  "invalid_column_headers": "string",
  "imports_not_found_or_not_available_for_accounts": "string",
  "imports_failed_for_accounts": "string",
  "imports_timed_out_for_accounts": "string",
  "imports_not_found_or_not_available_for_sites": "string",
  "imports_failed_for_sites": "string",
  "imports_timed_out_for_sites": "string",
  "file_level_error_rollups": [
    {
      "error_type": "string",
      "count": 1
    }
  ],
  "user_level_error_rollups": [
    {
      "error_type": "string",
      "count": 1
    }
  ],
  "user_level_warning_rollups": [
    {
      "warning_type": "string",
      "count": 1
    }
  ],
  "has_csv_results": true,
  "results_uri": "string"
}

Creates a request to close the accounts of existing users.

Given a CSV list of users, close their accounts.

Your CSV import file is made up of a header row with the column headers and a row of user or account data for each user whose account you want to close.

To ensure your CSV is properly formatted, use the Sample Bulk Update CSV file as a template. The following table describes the columns.

Column	Required	Description
AccountID	yes	The 32-character API account ID of the user’s account in your organization. You can find this value in the API and Keys section of the Admin area of the account.
AccountName		The name of the user’s account in your organization. The account name must match the account ID provided.
FirstName	yes	The user’s first name.
LastName	yes	The user’s last name.
UserEmail	yes	The user’s complete email address.
PermissionSet	yes	The user’s permission set. The PermissionSet value must match an existing permission set for the account. This value is not case sensitive.

Required authentication scopes: user_write.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequired

Request

This endpoint expects a multipart form containing a file.

file.csvfileRequired

CSV file.

Response

idstringOptionalformat: "uuid"

typestringOptional

requestorobjectOptional

createddatetimeOptional

last_modifieddatetimeOptional

statusstringOptional

Status.

user_countintegerOptional

processed_user_countintegerOptional

added_user_countintegerOptional

updated_user_countintegerOptional

closed_user_countintegerOptional

no_action_required_user_countintegerOptional

error_countintegerOptional

warning_countintegerOptional

invalid_column_headersstringOptional

imports_not_found_or_not_available_for_accountsstringOptional

imports_failed_for_accountsstringOptional

imports_timed_out_for_accountsstringOptional

imports_not_found_or_not_available_for_sitesstringOptional

imports_failed_for_sitesstringOptional

imports_timed_out_for_sitesstringOptional

file_level_error_rollupslist of objectsOptional

user_level_error_rollupslist of objectsOptional

user_level_warning_rollupslist of objectsOptional

has_csv_resultsbooleanOptional

results_uristringOptional