Skip to content

Send Issue

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

Enqueue or schedule a newsletter issue for sending.

202 Accepted: the request is validated and handed to the send worker (or persisted as scheduled) — actual SES delivery happens asynchronously. Poll g8_newsletter_get_issue to observe completion. scheduled_at omitted/null sends immediately; a malformed scheduled_at string returns 422 (not 500).

Authorizations

Parameters

Path Parameters

newsletter_id
required

Newsletter UUID

string format: uuid

Newsletter UUID

issue_id
required

Issue id

integer

Issue id

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Enqueue or schedule an issue for sending. scheduled_at omitted (or null) sends immediately.

object
scheduled_at
Any of:
string

Responses

202

Successful Response

object
data
required
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
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