Skip to main content
GET
Get mailbox changes

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Query Parameters

since_state
string

Legacy message state cursor to resume from.

types
string

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

messages_since_state
string

Message state cursor to resume from.

folders_since_state
string

Folder state cursor to resume from.

threads_since_state
string

Thread state cursor to resume from.

submissions_since_state
string

Submission state cursor to resume from.

identities_since_state
string

Identity state cursor to resume from.

quotas_since_state
string

Quota state cursor to resume from.

limit
integer

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

Required range: 1 <= x <= 500
mailbox_id
string

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

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required