PRprimitive
Mailbox access

Change a group

Renames a group or replaces its members. With an org-wide API key or the person's own Primitive CLI only role-free groups are changed. As on creation, a role naming a member's personal mailbox is never given through the group to anyone else (personal_mailbox_member_only).

patch/groups/{id}

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/groups/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The id of the group, role, member, grant or suspension the path names.

Request body

namestring
descriptionstring nullable
rolestring nullable
membersstring[]

Response

Change a group

successtrue required

Changes

No operation changes recorded.