Skip to content

Pause Send

POST
/newsletters/{newsletter_id}/issues/{issue_id}/send/pause

Ask a running send to stop. The stop button.

A REQUEST, not an instant state: recipients already leased by a worker are still delivered, and the reported state stays pausing until the reconciler confirms it settled. It does not lie about that, so poll GET .../send rather than assuming.

Deliberately NOT gated on the launch permission. Requiring a launch right to STOP a send would invert the safety model, and the app leaves it open for that reason.

Authorizations

Parameters

Path Parameters

newsletter_id
required

Newsletter id (UUID).

string format: uuid

Newsletter id (UUID).

issue_id
required

Issue id.

integer

Issue id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Why the send was stopped. Recorded on the send row.

object
reason
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a newsletter, an issue, a template or a send row.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string