Delete external web links

DELETE /api/configuration/externalweblinks

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Permanently removes one or more external web links. This is a hard delete — the links are removed outright, and there is no undo and no deleted flag to reverse.

The call is all-or-nothing. Every id you send is looked up first, and if any one of them does not exist the whole request fails with 404 and nothing at all is deleted — including the ids that did exist. Because deletion is a hard delete, the same request sent twice returns 404 on the second attempt.

Prefer deactivation when the link may be needed again: an external web link carries a Status of Active or InActive, and Update external web link can set it to InActive without destroying the record.

A successful call returns 204 No Content with no body.

Endpoint

DELETE {base_url}/api/configuration/externalweblinks

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Request body

Field	Type	Required	Description
`ids`	array of integer	Yes	The external web links to delete, identified by the `id` returned by List all external web links. Although marked optional, it is required: the request is rejected with `400` and `No external web links id provided.` when the field is missing, null or an empty array. Negative values are rejected with `Negative external web links IDs are not allowed.` Every id must exist: one unknown id fails the entire request with `404` and no link is deleted.

Sample request

cURL

curl -X DELETE '{base_url}/api/configuration/externalweblinks' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    12345
  ]
}'

Errors

Status	Meaning	When
`400`	Bad request	The body is missing, or `ids` is null or an empty array — `No external web links id provided.`
`400`	Bad request	One or more values in `ids` is negative — `Negative external web links IDs are not allowed.`
`404`	Not found	At least one id in `ids` does not match an existing external web link — `No external web links found for the following IDs: 12345, 12346`. Nothing is deleted, including the ids that were valid. This is also what a repeated delete of the same ids returns.
`500`	Internal server error	The delete could not be completed. The delete is all-or-nothing, so either all of the links are gone or none are, so the request is safe to retry.

This page as markdown · All pages · llms.txt