Skip Navigation Links

Page User Group Assignments

List assignable user groups

Requires authentication via bearer.

List and search user groups which can be assigned to a page by the actor.

Query Params

search_term string

A term that needs to match in the user group name, description or external id.

candidates_for string

Filter user groups that can be added to the given pageId.

page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

List page user group assignments

Requires authentication via bearer.

Searches the user group assignments of a page.

Path Params

page_id stringrequired

Unique identifier of a page.

Query Params

search_term string

A term that needs to match in the user group name, description or external id.

page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Assign user group to page

Requires authentication via bearer.

Assign a user group to a page.

Path Params

page_id stringrequired

Unique identifier of a page.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Request Body

user_group_id stringrequired

Unique identifier of a user group.

Response Body

200 OK

Error Codes

  • USER_GROUP_ALREADY_ASSIGNED

Delete page user group assignment

Requires authentication via bearer.

Removes a user group assignment from a page with all related users.

Path Params

page_id stringrequired

Unique identifier of a page.

group_id stringrequired

Unique identifier of a user group.

Response Body

200 OK