Stop an email channel's history sync for good

DELETE 
/api/inbox/channels/:channel/history-sync

STOP: a queued, running, paused or failed run becomes cancelled and its cursor and page offset are CLEARED, so it cannot be resumed (use pause for that). The counters stay, for the final numbers. The worker sees the stop at the next page boundary. A run that already ended (idle, completed, cancelled) is returned unchanged. Authorisation: see MailHistorySync.can_manage.

Request

Responses

200

The record after stopping.

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).

422

Not an email channel.