Sign in
Mailbox API

Get mailbox changes

Changed on

Returns message changes in the legacy shape when types is omitted. Pass a comma-separated types list for a typed state map.

get/mailbox/changes

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/changes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read)

Query parameters

since_statestring

Legacy message state cursor to resume from.

typesstring

Comma-separated list: messages, folders, threads, submissions, identities, quotas.

messages_since_statestring

Message state cursor to resume from.

folders_since_statestring

Folder state cursor to resume from.

threads_since_statestring

Thread state cursor to resume from.

submissions_since_statestring

Submission state cursor to resume from.

identities_since_statestring

Identity state cursor to resume from.

quotas_since_statestring

Quota state cursor to resume from.

limitinteger

Maximum change records to return (default 50, max 500).

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Mailbox changes

OR

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes