Deletes an organization from the system
DELETE /api/configuration/organisations/{all}
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Deletes an organisation — a partner or operator entity that sites can be mapped to. The organisation is removed permanently; there is no inactive flag involved, and this is not the same as setting isActive to false with Update organisation, which is the reversible option.
This endpoint runs no dependency check of its own. Unlike the status, title and medical condition type deletes, it does not look for organisation-to-site mappings before removing the record, so whether existing mappings block the delete or are removed with it is not defined by this endpoint. If you need the sites detached predictably, update the organisation's site list to empty first and then delete.
Deleting an organisation that does not exist returns 404 with Organisation ID {organisationId} could not be found, so a repeated delete gives you 404 rather than a no-op. A successful call returns 204 No Content with an empty body.
Endpoint
DELETE {base_url}/api/configuration/organisations/{all}
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
organisationId | integer (int32) | Yes | The organisation to delete, matching the id returned by Retrieve all organisations. The value is assigned by Gladstone at creation time — any id you send when creating an organisation is ignored — so it must come from a previous response. |
Sample request
curl -X DELETE '{base_url}/api/configuration/organisations/{all}' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true'Errors
| Status | Meaning | When |
|---|---|---|
404 | Not found | Organisation ID {organisationId} could not be found — no organisation with that id exists, which is also what you get from a repeated delete. The message is returned as the response body. |
500 | Internal server error | Any unexpected server-side failure, including the delete being refused because other records still reference the organisation. This endpoint does not translate that into a 409. |