Deletes a title
DELETE /api/configuration/titles/{titleId}
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Deletes a member title — the salutation code such as MR or DR that member records are set to. The title is removed permanently; there is no inactive flag and no undo.
The delete is refused while any member holds the title. If any member is linked to it, the endpoint returns 409 with There are members linked to the title ID {id}. Reassign those members to another title first; no member record is changed as a side effect of this call.
Send the id exactly as Retrieve all titles returns it. The id is matched exactly here, unlike the duplicate check on create, which is case-insensitive.
Deleting a title 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/titles/{titleId}
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
titleId | string | Yes | The title to delete, matching the id returned by Retrieve all titles. Matched exactly, so use the casing the list endpoint returns. |
Sample request
curl -X DELETE '{base_url}/api/configuration/titles/{titleId}' \
-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 title exists with that id, including when you repeat a delete that has already succeeded. The body is empty. |
409 | Conflict | There are members linked to the title ID {id} — at least one member currently uses this title. Move them to another title first. |
500 | Internal server error | Any other unexpected server-side failure. |