Update activity group

PUT /api/configuration/activity-groups/{all}

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

Overview

Changes the display text held against an existing activity group. Activity groups are the categories activities are filed under, so the text you set here is what a user sees when activities are grouped for browsing or selection. The groups and their identifiers are listed by GET /api/configuration/activity-groups.

This is a full replacement of the two writable fields, not a partial update. Both description and comments are written on every call from the values in the body. description is mandatory, so it cannot be left alone; omitting comments clears the stored comments rather than preserving them. Send the current value of comments alongside a new description if you only mean to change one of them.

Nothing else about the group is writable through this call. The identifier comes from the path and is not changed, and the activities assigned to the group are untouched.

A group that does not exist is not reported as an error. If no activity group matches the identifier in the path, nothing changes and the endpoint still returns 204 No Content. Confirm the identifier exists first, because a typo is indistinguishable from a successful update.

On success the response is 204 No Content with an empty body.

Endpoint

PUT {base_url}/api/configuration/activity-groups/{all}

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

Path parameters

Name	Type	Required	Description
`activityGroupId`	string	Yes	Identifier of the activity group to change, as listed by `GET /api/configuration/activity-groups`. An empty value is rejected with `400 ActivityGroupId must be specified`. An identifier that matches no group is silently accepted and changes nothing; see the Overview.

Request body

Field	Type	Required	Description
`description`	string	Yes	The group's display text, shown wherever activities are presented grouped. Mandatory: a blank or missing value is rejected with `400` and the message `Description cannot be blank`. Maximum 255 characters, beyond which the request fails with `The activity group description cannot be more than 255 characters`. Always written, so supply the existing text when your intent is only to change `comments`.
`comments`	string	No	Free-text note held against the group, maximum 255 characters (`Comments cannot be more than 255 characters`). The single value you send is written to both the kiosk and the web comments for the group; this endpoint cannot set them independently. Omitting the field, or sending null, clears both rather than leaving them as they were.

Sample request

cURL

curl -X PUT '{base_url}/api/configuration/activity-groups/{all}' \
  -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	The path identifier is empty or missing — body is the string `ActivityGroupId must be specified`.
`400`	Bad request	Body validation failed: `description` is blank, or `description` or `comments` exceeds 255 characters. The response body is a validation error object keyed by field name.
`400`	Bad request	The update references a record that does not exist — body is the string `Foreign keys being referenced do not exist`.
`409`	Conflict	The update conflicts with an existing activity group identifier — body is the string `Activity group ID already exists`.
`500`	Internal server error	Any other unexpected server-side failure. No detail is returned.

This page as markdown · All pages · llms.txt