Skip to content

Rename the inbox status paused to deactivated - #361

Merged
duharry0915 merged 1 commit into
mainfrom
harry/inbox-deactivated
Nov 6, 2026
Merged

duharry0915 merged 1 commit into
mainfrom
harry/inbox-deactivated

Conversation

@duharry0915

Copy link
Copy Markdown
Collaborator

Summary

The API renamed the inbox status paused to deactivated (agentmail-api #1945, in prod since 2026-11-06 03:36Z; paused now returns 400). The Fern definition and the docs pages follow:

  • fern/apis/api/definition/inboxes/__package__.yml: InboxStatus is active | deactivated; PauseAt / pause_at become DeactivateAt / deactivate_at on Inbox, CreateInboxRequest and UpdateInboxRequest; 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 use status: "deactivated" and deactivate_at / deactivateAt.
  • resources/errors.mdx: inbox_paused is inbox_deactivated; knowledge-base/api-403-error.mdx, inbox-capabilities.mdx, account-suspended.mdx, auto-forwarding.mdx and calendar/invitations.mdx prose follows.
  • Changelogs are left as history. No docs.yml change.

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

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>
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

📋 View the side-by-side API change review

The 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 review: false on the action.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

✨ 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 api-changelog-diff artifact or tag @fern Writer in #github-prs for changelog.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

@duharry0915
duharry0915 merged commit 9aba961 into main Nov 6, 2026
4 checks passed
@duharry0915
duharry0915 deleted the harry/inbox-deactivated branch November 6, 2026 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants