Update membership type group
PUT /api/configuration/membership-type-groups/{id}
- Products: Operator (
FOH) - Features: Front of House Generic Access (
FOHGENERIC)
Overview
Changes the label and comment held against a membership type group. A membership type group is a named collection of membership types, used to refer to several types at once — for example when picking an audience. Which membership types belong to the group is not set here; only these two text fields are writable.
This is a full replacement of both fields, not a partial update. Both fields are written on every call and anything you omit is written as null. Send both values even when you only mean to change one.
The group must already exist; an unknown identifier returns 404 before anything is attempted. The
identifier itself is not writable — to change it, create a new group and delete the old one.
On success the response is 204 No Content and the change is visible on the next read. Note that group
membership is read elsewhere: consumers that need the individual membership types in a group fetch
them from GET /api/configuration/membership-types/groups?groupIds={id}.
Endpoint
PUT {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 | Identifier of the membership type group to change, up to 15 characters, as listed by the membership type group endpoints. If it matches no group the request fails with 404 Unable to find Membership Type Group with id {id} to update. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
description | string | No | The group's display label, shown wherever groups are listed for selection. Maximum 25 characters (Description cannot exceed 25 characters.), a hard limit with no leeway. Written on every call: omit it or send null and the stored label is cleared, leaving the group with no name. |
comments | string | No | Free-text note against the group, held as the group's web comments. Maximum 255 characters (Comments cannot exceed 255 characters.). Written on every call, so omitting it or sending null clears the stored note. It is returned as comments by the group retrieval endpoints. |
Sample request
curl -X PUT '{base_url}/api/configuration/membership-type-groups/{id}' \
-H 'Authorization: Bearer {accessToken}' \
-H 'X-Use-SSO: true' \
-H 'Content-Type: application/json' \
-d '{
"description": "string",
"comments": "string"
}'Errors
| Status | Meaning | When |
|---|---|---|
400 | Bad request | description exceeds 25 characters or comments exceeds 255 characters — the body is a validation problem document keyed by field name. Also returned for any other invalid argument in the request, with a plain-text message describing it as the body. |
404 | Not found | No membership type group has that identifier — Unable to find Membership Type Group with id {id} to update. Checked before the update is attempted. |
409 | Conflict | The save failed because it conflicted with existing data; the underlying error message is returned as the body. |
500 | Internal server error | Any other unexpected server-side failure. No detail is returned. |