Update an inbox
cooper_update_inboxUse this when an inbox should stop sending and accepting new mail without deleting the address, threads, or history (for example while a human reviews it or during an incident), when it should start again, when you need to set its display name or metadata, when you need to change inbound screening, or when you need to change send_mode. Requires auth. Inputs: inbox_id (required; inbox id, username, or email), status (optional; active or paused), require_sender_auth (optional boolean), display_name (optional string, or null to clear it), metadata (optional object merged into the current metadata; a null value removes that key), screening (optional; off, observe, or hold), send_mode (optional; direct or approval). At least one of those fields is required. A metadata object allows at most 256 keys, keys of at most 256 characters, and string, number, or boolean values. The stored JSON must be at most 16 KB. Otherwise the call returns HTTP 400 invalid_metadata. screening other than off, observe, or hold returns HTTP 400 invalid_screening. send_mode other than direct or approval returns HTTP 400 invalid_send_mode. Entering approval applies immediately when a verified owner exists and turns POST /messages, reply, reply-all, and forward into a pending draft and emails those owners. No verified owner returns HTTP 409 owner_required and leaves send_mode unchanged. An inbox already in approval can be set back to direct only when it has never had a verified owner. An unsubscribed owner, or a username pinned by an owner-confirmed delete, stays in approval. Leaving approval for direct when a verified owner exists emails those owners and waits until they confirm, including PATCH on an inbox whose username is batch. Opening the confirm link does not change the inbox. The copy stored in the agent inbox does not include the confirm token, and an API key cannot submit that link. off skips scoring and records reason screening_off. observe, the default, stores every message and adds the suspicious label when the heuristic score is 40 or higher. hold stores suspicious mail with the held label, fires message.held instead of message.received, and creates no task. Screening never drops mail. Pausing sets paused_at to now and keeps that timestamp if you pause again. Resuming clears paused_at. Resuming an active inbox changes nothing. A paused inbox still counts toward the plan inbox limit, and existing messages stay readable. Sends return HTTP 403 inbox_paused until status is active. Returns the inbox {id, username, email, display_name, created_at, require_sender_auth, labels, expires_at, status, paused_at, metadata, client_id, screening, send_mode}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | paused stops new sends and drops new inbound mail. active resumes the inbox. | |
| inbox_id | Yes | Inbox id (inb_…), username, or full email address owned by this key | |
| metadata | No | Merged into the current metadata. A null value removes that key. At most 256 keys, keys at most 256 characters, values string number or boolean, serialized at most 16 KB. Otherwise 400 invalid_metadata. | |
| screening | No | Inbound prompt-injection screen. off skips scoring and records why. observe labels suspicious mail. hold stores suspicious mail for review and fires message.held. Anything else is 400 invalid_screening. | |
| send_mode | No | Entering approval applies immediately when a verified owner exists and holds POST /messages, reply, reply-all, and forward until that owner approves the current content. No verified owner returns HTTP 409 owner_required. An inbox already in approval can return to direct only when it has never had a verified owner. An unsubscribed owner still blocks that switch. Leaving approval for direct emails verified owners and waits for confirmation. Anything else is 400 invalid_send_mode. | |
| display_name | No | From display name. Send null to clear it. A blank string also clears it. | |
| require_sender_auth | No | When true, owner or allowlist mail becomes a task only if DMARC passes or DKIM passes and aligns with From. |