Skip to main content
POST
/
external_users
/
submit_delete_job
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"
         }
       ]
     }'
{
  "entries": [
    {
      "user_id": "12345",
      "status": 202,
      "detail": "<string>"
    }
  ]
}
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.

Response

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.