Repository navigation
Rename the inbox status paused to deactivated - #361
Merged
Merged
Conversation
The API renamed the status (agentmail-api #1945, in prod since 2026-11-06): `InboxStatus` is `active | deactivated`, the schedule field is `deactivate_at`, and the send error code is `inbox_deactivated`. The definition and the pages follow; the changelogs stay as history. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
📋 View the side-by-side API change reviewThe link expires in 7 days. 🔒 Your API specs are encrypted in CI before they're uploaded. The decryption key stays in this link's URL fragment (after the #), which browsers never send to a server, so oasdiff cannot read your specs. How it works → Posted automatically by the oasdiff GitHub Action. To turn this off (no spec upload, no comment), set |
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### GET /v0/inboxes
- :warning: added the new `deactivated` enum value to the `inboxes/items/status` response property for the response status `200`
- added the optional property `inboxes/items/deactivate_at` to the response with the `200` status
- removed the optional property `inboxes/items/pause_at` from the response with the `200` status
- removed the `paused` enum value from the `inboxes/items/status` response property for the response status `200`
### POST /v0/inboxes
- :warning: removed the enum value `paused` of the request property `status`
- :warning: added the new `deactivated` enum value to the `status` response property for the response status `200`
- :warning: removed the request property `pause_at`
- added the new optional request property `deactivate_at`
- added the new `deactivated` enum value to the request property `status`
- added the optional property `deactivate_at` to the response with the `200` status
- removed the optional property `pause_at` from the response with the `200` status
- removed the `paused` enum value from the `status` response property for the response status `200`
### GET /v0/inboxes/search
- :warning: added the new `deactivated` enum value to the `inboxes/items/status` response property for the response status `200`
- added the optional property `inboxes/items/deactivate_at` to the response with the `200` status
- removed the optional property `inboxes/items/pause_at` from the response with the `200` status
- removed the `paused` enum value from the `inboxes/items/status` response property for the response status `200`
### GET /v0/inboxes/{inbox_id}
- :warning: added the new `deactivated` enum value to the `status` response property for the response status `200`
- added the optional property `deactivate_at` to the response with the `200` status
- removed the optional property `pause_at` from the response with the `200` status
- removed the `paused` enum value from the `status` response property for the response status `200`
### PATCH /v0/inboxes/{inbox_id}
- :warning: removed the enum value `paused` of the request property `status`
- :warning: added the new `deactivated` enum value to the `status` response property for the response status `200`
- :warning: removed the request property `pause_at`
- added the new optional request property `deactivate_at`
- added the new `deactivated` enum value to the request property `status`
- added the optional property `deactivate_at` to the response with the `200` status
- removed the optional property `pause_at` from the response with the `200` status
- removed the `paused` enum value from the `status` response property for the response status `200`
### GET /v0/pods/{pod_id}/inboxes
- :warning: added the new `deactivated` enum value to the `inboxes/items/status` response property for the response status `200`
- added the optional property `inboxes/items/deactivate_at` to the response with the `200` status
- removed the optional property `inboxes/items/pause_at` from the response with the `200` status
- removed the `paused` enum value from the `inboxes/items/status` response property for the response status `200`
### POST /v0/pods/{pod_id}/inboxes
- :warning: removed the enum value `paused` of the request property `status`
- :warning: added the new `deactivated` enum value to the `status` response property for the response status `200`
- :warning: removed the request property `pause_at`
- added the new optional request property `deactivate_at`
- added the new `deactivated` enum value to the request property `status`
- added the optional property `deactivate_at` to the response with the `200` status
- removed the optional property `pause_at` from the response with the `200` status
- removed the `paused` enum value from the `status` response property for the response status `200`
### GET /v0/pods/{pod_id}/inboxes/search
- :warning: added the new `deactivated` enum value to the `inboxes/items/status` response property for the response status `200`
- added the optional property `inboxes/items/deactivate_at` to the response with the `200` status
- removed the optional property `inboxes/items/pause_at` from the response with the `200` status
- removed the `paused` enum value from the `inboxes/items/status` response property for the response status `200`
### GET /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: added the new `deactivated` enum value to the `status` response property for the response status `200`
- added the optional property `deactivate_at` to the response with the `200` status
- removed the optional property `pause_at` from the response with the `200` status
- removed the `paused` enum value from the `status` response property for the response status `200`
### PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: removed the enum value `paused` of the request property `status`
- :warning: added the new `deactivated` enum value to the `status` response property for the response status `200`
- :warning: removed the request property `pause_at`
- added the new optional request property `deactivate_at`
- added the new `deactivated` enum value to the request property `status`
- added the optional property `deactivate_at` to the response with the `200` status
- removed the optional property `pause_at` from the response with the `200` status
- removed the `paused` enum value from the `status` response property for the response status `200`
## Components
- removed the schema `inboxesPauseAt`💡 Download |
sidharth0612
approved these changes
Nov 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The API renamed the inbox status
pausedtodeactivated(agentmail-api #1945, in prod since 2026-11-06 03:36Z;pausednow returns 400). The Fern definition and the docs pages follow:fern/apis/api/definition/inboxes/__package__.yml:InboxStatusisactive | deactivated;PauseAt/pause_atbecomeDeactivateAt/deactivate_atonInbox,CreateInboxRequestandUpdateInboxRequest; the update endpoint docs link to the renamed section.core-concepts/inboxes.mdx: "Pausing an inbox" is "Deactivating an inbox" (anchor#deactivating-an-inbox), "Scheduling a pause" is "Scheduling a deactivation"; samples usestatus: "deactivated"anddeactivate_at/deactivateAt.resources/errors.mdx:inbox_pausedisinbox_deactivated;knowledge-base/api-403-error.mdx,inbox-capabilities.mdx,account-suspended.mdx,auto-forwarding.mdxandcalendar/invitations.mdxprose follows.docs.ymlchange.fern check: 0 errors. The SDKs pick the rename up on the next regen (InboxStatus,deactivateAt/deactivate_at); the console widens its type until then (agentmail-web #1370).🤖 Generated with Claude Code