PRprimitive
Mailbox access

Create a group

Creates a group. Needs roles:assign. With an org-wide API key (acting for its person) or the person's own Primitive CLI the group must have no role: a group with a role is role assignment, done in a dashboard session or with a session step-up. Adding members to a group that holds mailbox access gives them that access, so each of its entries is checked as for a mailbox edit. A group whose role names a member's personal mailbox holds only that member: giving the role to, or adding, anyone else is refused with 403 grant_forbidden and details.reason personal_mailbox_member_only.

post/groups

Request

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

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

namestring required
descriptionstring nullable
rolestring nullable
membersstring[]

Response

Create a group

successtrue required

Changes

No operation changes recorded.