Complete Newsletter

POST

/newsletters/{newsletter_id}/complete

• Production
• QA

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

• BearerAuth

Parameters

Path Parameters

newsletter_id

required

Newsletter id.

string format: uuid

Newsletter id.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

The result of a lifecycle transition.

object

id

Any of:

string

string

null

null

status

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string