---
title: "Share your own mailbox"
method: PUT
path: "/me/mailboxes/{address}/access"
tags: ["Roles and members"]
---

# Share your own mailbox

`PUT /me/mailboxes/{address}/access`

## Request

- Base URL: `https://api.primitive.dev/v1`
- URL: `https://api.primitive.dev/v1/me/mailboxes/{address}/access`
- Auth: HTTP bearer

Replaces the access list of the caller's own member mailbox (or their personal agent's address); needs no delegations:manage. Nobody grants access beyond their own. Person only: a dashboard session, or the person's own OAuth or CLI token with a session step-up of purpose `delegations.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 member_address:manage. API keys are refused.

## Path parameters

- `address` string, required

## Request body

- SetOwnMailboxAccessRequest
  - `entries` object[], required
    - `principal` object, required
      - `kind` 'member' | 'group' | 'agent' | 'address', required
      - `id` string, required
    - `actions` string[], required
    - `depth` 'metadata' | 'content' | 'raw'

## Response `200`

Share your own mailbox

- object
  - `success` true, required
  - `data` SetOwnMailboxAccessResult, required
    - `entries` object[], required
      - `id` string, required
      - `mailbox_address` string, nullable, required
      - `mailbox_domain` string, nullable, required
      - `mailbox_kind` 'personal' | 'shared' | 'agent' | 'app', nullable, required
      - `principal_kind` 'member' | 'group' | 'agent' | 'app' | 'address', required
      - `principal_user_id` string, nullable, required
      - `principal_group_id` string, nullable, required
      - `principal_agent_connection_id` string, nullable, required
      - `principal_address` string, nullable, required
      - `actions` string[], required
      - `depth` 'metadata' | 'content' | 'raw', required
      - `created_at` string, required
      - `updated_at` string, required

## 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)