Box Developer Documentation
Log in
Latest version

Submit job to delete external users

post
https://api.box.com/2.0
/external_users/submit_delete_job

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

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Request Body

object arrayin bodyrequired

List of external users to delete.

stringin bodyrequired
"12345"

The unique identifier for the user.

stringin bodyrequired
"user"

The value is always user.

Value is always user

Response

application/jsonExternal Users Submit Delete Job Response

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

application/jsonClient error

Returns an error if the listed external users are not found, or the authenticated user does not have the right permissions to delete external users.

application/jsonClient error

An unexpected client error.

post
Submit job to delete external users
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


Node/TypeScript v10
await client.externalUsers.submitJobToDeleteExternalUsersV2025R0({
  externalUsers: [
    new UserReferenceV2025R0({ id: getEnvVar('BOX_EXTERNAL_USER_ID') }),
  ],
} satisfies ExternalUsersSubmitDeleteJobRequestV2025R0);
Python v10
client.external_users.submit_job_to_delete_external_users_v2025_r0(
    [UserReferenceV2025R0(id=get_env_var("BOX_EXTERNAL_USER_ID"))]
)
.NET v10
await client.ExternalUsers.SubmitJobToDeleteExternalUsersV2025R0Async(requestBody: new ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: Array.AsReadOnly(new [] {new UserReferenceV2025R0(id: Utils.GetEnvVar(name: "BOX_EXTERNAL_USER_ID"))})));
Swift v10
try await client.externalUsers.submitJobToDeleteExternalUsersV2025R0(requestBody: ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: [UserReferenceV2025R0(id: Utils.getEnvironmentVariable(name: "BOX_EXTERNAL_USER_ID"))]))
Java v10
client.getExternalUsers().submitJobToDeleteExternalUsersV2025R0(new ExternalUsersSubmitDeleteJobRequestV2025R0(Arrays.asList(new UserReferenceV2025R0(getEnvVar("BOX_EXTERNAL_USER_ID")))))

Response Example

{
  "entries": [
    {
      "status": 202,
      "user_id": "12345"
    }
  ]
}