Submit job to delete external users

Delete external users from current user enterprise. This will remove each external user from all invited collaborations within the current enterprise.

POST /external_users/submit_delete_job

cURL

cURL

curl -i -X POST "https://api.box.com/2.0/external_users/submit_delete_job" \
     -H "box-version: 2025.0" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "external_users": [
         {
           "type": "user",
           "id": "12345"
         }
       ]
     }'

client.external_users.submit_job_to_delete_external_users_v2025_r0(
    [UserReferenceV2025R0(id=get_env_var("BOX_EXTERNAL_USER_ID"))]
)

await client.externalUsers.submitJobToDeleteExternalUsersV2025R0({
  externalUsers: [
    new UserReferenceV2025R0({ id: getEnvVar('BOX_EXTERNAL_USER_ID') }),
  ],
} satisfies ExternalUsersSubmitDeleteJobRequestV2025R0);

try await client.externalUsers.submitJobToDeleteExternalUsersV2025R0(requestBody: ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: [UserReferenceV2025R0(id: Utils.getEnvironmentVariable(name: "BOX_EXTERNAL_USER_ID"))]))

client.getExternalUsers().submitJobToDeleteExternalUsersV2025R0(new ExternalUsersSubmitDeleteJobRequestV2025R0(Arrays.asList(new UserReferenceV2025R0(getEnvVar("BOX_EXTERNAL_USER_ID")))))

await client.ExternalUsers.SubmitJobToDeleteExternalUsersV2025R0Async(requestBody: new ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: Array.AsReadOnly(new [] {new UserReferenceV2025R0(id: Utils.GetEnvVar(name: "BOX_EXTERNAL_USER_ID"))})));

207

{
  "entries": [
    {
      "user_id": "12345",
      "status": 202,
      "detail": "<string>"
    }
  ]
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

Learn more about Box SDK versioning strategy.

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

box-version · enum<string> · required

Version header.

Available options: 2025.0

Body

application/json

Request to submit a job to delete external users from the current enterprise.

external_users · User reference · object[] · required

List of external users to delete.

Show child attributes

Response

207

application/json

Multi-status response containing the result for each external user deletion request.

Multi-status response containing the result for each external user deletion request.

entries · External User Deletion Result · object[] · required

Array of results of each external user deletion request.

Show child attributes