Save guest list settings

Replace the configured guest list for an event. The body is the full guest list: groups, people, and external guests omitted from it are removed. First retrieve the current settings from /api/events/{id}/guest-list/settings, apply your changes, then send back the full object.

Required permission: Full Write Events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the event.

Body Params

The guest list to save.

groups
array of objects | null

The groups assigned to the guest list, including check-in session groups.

groups
people
array of objects | null

The people with profiles manually added to the guest list.

people
external
array of objects | null

The people without profiles manually added to the guest list.

external
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json