Groups API
A group is a named bundle of permissions on a team that several collaborators hold at once: put the three people who run the inbox into a Support group and they share its permissions, take one out and they keep only what their own role gives them.
A group is a named bundle of permissions on a team that several collaborators hold at once: put the three people who run the inbox into a Support group and they share its permissions, take one out and they keep only what their own role gives them. Groups sit beside roles, which are assigned one per collaborator; a group is the way to grant the same extra permissions to a set of people without editing each role.
Each group carries permissions, the exact ability strings a token can hold, and member_ids, the collaborators in it. Both are returned when a group is read individually or after a write and omitted from the list so a listing stays one query. Membership is replaced as a whole with PUT …/members, so a sync from your own directory sends the full list each time rather than adding and removing one by one. Deleting a group removes what it granted from everyone in it; nobody leaves the team.
Visibility is the union of every team the caller owns or belongs to, and a group on a team outside that set answers 404 RESOURCE_NOT_FOUND rather than 403, so the API never confirms that a team exists. Every write announces itself as a group.* event.
Endpoints
/v1/groupsList groupsPOST/v1/groupsCreate a groupGET/v1/groups/{group}Get a groupPATCH/v1/groups/{group}Update a groupDELETE/v1/groups/{group}Delete a groupPUT/v1/groups/{group}/membersReplace a group's membersRelated
How is this guide?
Last updated on