v1
latestOpenAPI 3.1.02026-07-2670105729.6 KBEmails
Pause a gradual send
Manually pauses an in-flight GRADUAL (domain-warmup) send. The delivering workflow parks the current day’s remaining tranche at its next gate poll (≤120s) and holds until POST /v1/sends/{sendId}/resume (or a cancel). A send that is not a sending gradual send returns 409 SEND_NOT_PAUSABLE. Brand-scoped: an unknown / cross-brand sendId is 404.
post/v1/sends/{sendId}/pause
Path parameters
sendIdstring required
Send id returned by POST /v1/sends.
Example:snd_8fK2mQ4p
Send id returned by POST /v1/sends.
Headers
Idempotency-Keystring
Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.
Response
The send is paused.