Sample - Box Platform API
DELETE/web_links/{web_link_id}

Remove a web link

Deletes a specific web link. Use web_link_id to identify the web link that you want to remove. A successful deletion returns no response body.

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

1 parameter
web_link_idstringrequired
The unique identifier of the web link to delete.

2 status codes
204Returns an empty response after the web link is successfully deleted.
defaultReturned when an unexpected client error occurs.
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

web_link_id must identify an existing web link. Provide the identifier in the format accepted for web link resources.