Deletes a status

DELETE /api/configuration/statuses/{all}

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

Overview

Deletes a member status — the code that classifies a member's standing, such as active or suspended. The status is removed permanently; there is no inactive flag and no undo.

The delete is refused while any member holds the status. If any member is linked to it, the endpoint returns 409 with The status ID {id} is linked to members. Reassign those members to another status first; nothing on this endpoint will do it for you, and no member record is modified as a side effect.

Status identifiers are converted to uppercase with spaces removed when a status is created. Send the id exactly as Retrieve all member statuses returns it.

Deleting a status that does not exist returns 404, so a repeated delete gives you 404 rather than a silent success. A successful call returns 204 No Content with an empty body.

Endpoint

DELETE {base_url}/api/configuration/statuses/{all}

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

Path parameters

Name	Type	Required	Description
`statusId`	string	Yes	The status to delete, matching the `id` returned by Retrieve all member statuses. Converted to uppercase with spaces removed at creation time, and matched here exactly, so send it in the casing the list endpoint returns.

Sample request

cURL

curl -X DELETE '{base_url}/api/configuration/statuses/{all}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

Status	Meaning	When
`400`	Bad request	The id path segment is empty. The body is the literal string `Id cannot be null or empty`.
`404`	Not found	No status exists with that id, including when you repeat a delete that has already succeeded. The body is empty.
`409`	Conflict	`The status ID {id} is linked to members` — at least one member currently has this status. Move them to another status first.
`500`	Internal server error	Any other unexpected server-side failure.

This page as markdown · All pages · llms.txt