Turn off a project's inbox
Platform module
POST/project-inboxes/{id}/disableprojectInboxes.disable
Stops the address accepting mail (app.disable_project_inbox). Mail already received stays; a disabled address never comes back. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability projects.settings.write.
- OAuth scopes: projects.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the project inbox. |
Response 200: ProjectInbox
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the project inbox. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| project_id | string (uuid) | Yes | Identifier of the project the inbox belongs to. |
| local_part | string | Yes | Part before the @ of the receiving domain: the project key and a random suffix.Constraints: length 1 to 63 |
| disabled_at | string (date-time) | null | Yes | When the address stopped accepting mail. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"local_part": "nwl-0a1b2c3d4e",
"disabled_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/project-inboxes/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/disable" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.projectInboxes.disable("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.project_inboxes.disable("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos project-inboxes disable 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f