---
title: "Add Mailbox To Workspace"
method: POST
path: "/inbox/workspaces/{workspace_id}/mailboxes"
tags: ["AI Inbox"]
---

# Add Mailbox To Workspace

`POST /inbox/workspaces/{workspace_id}/mailboxes`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/workspaces/{workspace_id}/mailboxes`
- Auth: HTTP bearer

Put a mailbox into a workspace.

IDEMPOTENT: adding a mailbox that is already a member is a no-op, and the
response says which happened rather than failing.

This one handler wants a `PropelAuthUser` rather than the shared principal,
so it gets one from `build_api_principal` - resolved from the validated
key, never client-supplied.

## Path parameters

- `workspace_id` string, required: Workspace id (UUID).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- BodyAddMailboxToWorkspaceInboxWorkspacesWorkspaceIdMailboxesPost
  - `mailbox_id` integer, required: Integer `mailboxes.id` - the database primary key, NOT the cron-job string id. The app is explicit about the difference and so is this.

## Response `201`

Successful Response

- ApiResponseInboxPayload
  - `data` InboxPayload, required: An open envelope for a comment, an assignment or a workspace. Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)