Pause an email channel's history sync

POST 
/api/inbox/channels/:channel/history-sync/pause

PAUSE: a queued/running run becomes paused. The cursor, page offset and counters are kept, so POST /history-sync {resume: true} continues from the same message. The worker stops at the next page boundary. Authorisation: see MailHistorySync.can_manage.

Request

Responses

200

The record after pausing.

401

Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).

403

Authenticated but not allowed.

404

Resource not found (or not visible to the current tenant).

409

Nothing to pause — the run is not queued or running.

422

Not an email channel.