---
title: "Switch the mailbox access mode"
method: PUT
path: "/access-mode"
tags: ["Roles and members"]
---

# Switch the mailbox access mode

`PUT /access-mode`

## Request

- Base URL: `https://api.primitive.dev/v1`
- URL: `https://api.primitive.dev/v1/access-mode`
- Auth: HTTP bearer

Delegated mode is refused until every preview item has a decision; switching back to whole-org is always allowed. Person only: a dashboard session, or the person's own OAuth or CLI token with a session step-up of purpose `access_mode.write` (the person confirms at the step_up_url a 403 step_up_required answer carries, which names this client, then send the token in the Primitive-Step-Up header; the token works only with the client it was confirmed for). Needs access_mode:manage (owners). API keys are refused.

## Request body

- SetAccessModeRequest
  - `mode` 'whole_org' | 'delegated', required

## Response `200`

Switch the mailbox access mode

- object
  - `success` true, required
  - `data` SetAccessModeResult, required
    - `mode` 'whole_org' | 'delegated', required
    - `changed` boolean, required
    - `items_listed` unknown
    - `revoked` unknown
    - `settled` number

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key
- `403`: Authenticated caller lacks permission for the operation
- `404`: feature_disabled: the feature is not enabled for the organization; or not_found: the item the path names does not exist.
- `409`: conflict: the item changed while you edited it, or a member was removed and added back. Look again, then retry.
- `429`: Rate limit exceeded. The `ratelimit-*` headers describe the limiter that rejected this request, with its own limit and window, not the API budget that successful responses report. A limiter that reports only a wait sends `Retry-After` alone.

---

[API](https://skmtc.dev/primitive/apis/primitive-api.md) - [All operations](https://skmtc.dev/primitive/apis/primitive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/primitive/apis/primitive-api/revisions/bce409c97acb?raw)