Delete membership type group

DELETE /api/configuration/membership-type-groups/{id}

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

Overview

Permanently removes a membership type group — the named grouping that membership types are collected under. This is a hard delete: the group is removed outright and there is no deleted or inactive flag, so there is no deactivate alternative and nothing to reverse.

The group must be empty and unreferenced. Before deleting, the endpoint checks four things, and if any of them holds the call is refused with 409 and the message Membership Type Group is in use. — the same message in every case, so it will not tell you which one applies. The group is in use if a membership type is assigned to it, if an access control question is scoped to it, if it appears as either side of a membership group add-on relationship, or if a membership type restriction refers to it. Clear those references first; use Retrieve membership types by membership type group to see which membership types are assigned.

Existence is checked before the delete, so repeating the same request returns 404.

A successful call returns 204 No Content with no body, and subsequent reads reflect the deletion immediately.

Endpoint

DELETE {base_url}/api/configuration/membership-type-groups/{id}

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

Path parameters

Name	Type	Required	Description
`id`	string	Yes	The membership type group to delete, identified by the `id` returned by List all membership type groups. This is the short code assigned when the group was created, not a numeric key.

Sample request

cURL

curl -X DELETE '{base_url}/api/configuration/membership-type-groups/{id}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

Status	Meaning	When
`404`	Not found	No membership type group exists with that id — `Unable to find Membership Type Group with id MEMBER to delete.` This is also what a repeated delete of the same group returns.
`409`	Conflict	The group is still referenced — `Membership Type Group is in use.` Raised when a membership type is assigned to the group, an access control question is scoped to it, it appears on either side of a membership group add-on, or a membership type restriction refers to it. The message is identical in all four cases and does not identify the offending record. Nothing is deleted.
`500`	Internal server error	An unexpected server-side failure during the delete. This is also what you get if the group is removed by another caller between the existence check and the delete. Nothing is deleted, and the request is safe to retry.

This page as markdown · All pages · llms.txt