Skip to content

Complete Newsletter

POST
/newsletters/{newsletter_id}/complete

Mark a newsletter completed. Terminal - it stops sending for good.

The internal handler validates the transition, so an illegal move from the current status is refused there rather than silently applied.

Authorizations

Parameters

Path Parameters

newsletter_id
required

Newsletter id.

string format: uuid

Newsletter id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

The result of a lifecycle transition.

object
id
Any of:
string
status
Any of:
string
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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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