Skip Navigation Links

Channel Assignments User Groups

List Channel User Group Assignments

Requires authentication via bearer.

Gets all user groups that are assigned to the channel.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

Query Params

search_term string

A term that needs a a match in the user groups' name.

embed string[]
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.

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Create User Group Assignment

Requires authentication via bearer.

Assigns a user group to the channel. All users with that are assigned to the user group or any descendent will be assigned to the channel. Any existing channel user assignments for users that are part of this user group will be managed by the user group after this call.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

Request Body

user_group_id stringrequired

The primary identifier of the user group.

Response Body

201 Created

Error Codes

  • ASSIGNMENT_ALREADY_EXISTS
  • CHANNEL_NOT_FOUND
  • INVALID_USER_GROUP
  • CANNOT_ASSIGN_TO_OPEN_CHANNEL

Delete User Group Assignment

Requires authentication via bearer.

Deletes the user group assignment for the channel. Users that are part of this user group or any descendent will be removed from the channel, unless there is another user group assigned to the channel that contains them.

Path Params

channel_id stringrequired

The primary identifier of the channel to access.

user_group_id stringrequired

The primary identifier of the user group.

Response Body

200 OK