Sample - Box Platform API
DELETE/users/{user_id}

Delete user

Deletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the force parameter to delete the user and their files.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
user_idstringrequired
The ID of the user.
notifybooleanoptional
Whether the user will receive email notification of the deletion.
forcebooleanoptional
Specifies whether to delete the user even if they still own files.

2 status codes
204Removes the user and returns an empty response.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.