Close external memberships

POST

/v2/organizations/:organizationId/imports/bulk_users/close_external

POST

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

curl -X POST https://api-d.docusign.net/Management/v2/organizations/organizationId/imports/bulk_users/close_external \
     -H "Authorization: Bearer <token>"

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"
}

Closes external memberships.

External memberships are users who have an email address at a verified domain but do not belong to the organization.

Required authentication scopes: user_write.

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization ID Guid

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