Mailboxes
Update a mailbox grant
Changes a member's role, send mode, or both on a mailbox and returns the updated grant.
Changes a member's role, send mode, or both on a mailbox and returns the updated grant. A field left out keeps its value; naming neither is a validation error. Taking admin from the last grant that can configure the mailbox conflicts, as revoking it does. The change applies to the member's next request on every surface.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$grantId*string
Match
^mbxacl_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
role?|null
sendMode?|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/mailboxes/string/grants/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "actor": { "kind": "user", "id": "string", "displayName": "string" }, "permissions": [ "mailbox:read" ], "sendMode": "send", "createdAt": "string"}