Mailboxes
Grant a member access to a mailbox
Shares a mailbox with an organization member and returns the grant with status 201.
Shares a mailbox with an organization member and returns the grant with status 201. The member must already belong to the organization. A member who already holds a grant conflicts rather than being rewritten: change an existing grant with PATCH /v1/mailboxes/{id}/grants/{grantId}, so a grant is never widened as a side effect of granting. List the current grants with GET /v1/mailboxes/{id}/grants.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
userId*UserId
Match
^user_[0-9a-hjkmnp-tv-z]{16,24}$role*MailboxGrantRole
Value in
- "admin"
- "collaborator"
- "viewer"
sendMode?|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/mailboxes/string/grants" \ -H "Content-Type: application/json" \ -d '{ "userId": "string", "role": "admin" }'{ "id": "string", "actor": { "kind": "user", "id": "string", "displayName": "string" }, "permissions": [ "mailbox:read" ], "sendMode": "send", "createdAt": "string"}