Delete form profile
DELETE /api/configuration/form-profiles/{formProfileId}
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Permanently removes a form profile — the reusable definition of a sign-up or account form. This is a hard delete: the profile is removed outright, there is no deleted or inactive flag, and the profile cannot be recovered.
One rule blocks the delete. A form profile that is currently set as the default is refused with 409. A profile counts as a default when its id is the value of any of four configuration keys — Join_MemberSignUpForm, Join_GuestSignUpForm, Book_GuestBookingForm or Book_MyAccountForm. Repoint the relevant key at a different profile first, then delete. Nothing else is checked: a profile that is merely referenced by your own integration, rather than set as one of those defaults, is deleted without warning.
Because the delete is permanent, sending the same request twice returns 404 on the second attempt.
A successful call returns 204 No Content with no body, and the profile stops appearing in List all form profiles.
Endpoint
DELETE {base_url}/api/configuration/form-profiles/{formProfileId}
{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
formProfileId | integer (int32) | Yes | The form profile to delete, identified by the id returned by List all form profiles. Must be a 32-bit integer — a non-numeric segment is rejected with 400 before anything else is checked. |
Sample request
curl -X DELETE '{base_url}/api/configuration/form-profiles/{formProfileId}' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true'Errors
| Status | Meaning | When |
|---|---|---|
400 | Bad request | formProfileId is not a valid integer, and is rejected before anything else is checked — The value 'invalid_profile_id' is not valid. |
404 | Not found | No form profile exists with that id — No form profile could be found with the ID of 12345. This is also what a repeated delete of the same profile returns. |
409 | Conflict | The profile is the default for one of the four form profile configuration keys — The form profile with the ID of 12345 is already in use as the default for the form type {key}, where {key} is the form type key of the profile being deleted. The profile is left intact; repoint the configuration key at another profile and retry. |
500 | Internal server error | The delete could not be completed, or another unexpected server-side failure occurred. Nothing is deleted, and the request is safe to retry. |