Set group access

Sets a broadcast group's access mode and, for a PRIVATE group, each listed team member's access level.

  • PUBLIC: every team member can access the group. teamMembers is ignored.
  • PRIVATE: only team members with an access level can access the group. Team members are identified by the phone number on their DoubleTick account.

The access mode is always applied. Team members are then updated one by one, and an entry that cannot be applied fails only itself: it is returned in failed with a reason and the rest are still updated. An entry fails when its phone number is invalid or repeated in the request, does not belong to a team member of the organisation, or belongs to a team member whose access level cannot be changed (the group creator, or a team member whose role has the "manage channel access" permission, such as owner or admin, who always has full access).

Requires the "manage channels" permission and the "manage channel access" permission for this group.

Rate limited to 60 requests per minute, per organisation and user.

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

The group ID

Body Params
string
enum
required

PUBLIC: every team member can access the group. PRIVATE: only team members with an access level can access it.

Allowed:
teamMembers
array of objects

Team members and their access levels. Used only when accessMode is PRIVATE; ignored for PUBLIC.

teamMembers
Responses

failed for team members that were not updated.

400

Bad request: invalid input provided, or the group was not found in this organisation

401

Invalid or missing API key

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