Skip to main content
POST
Send an existing newsletter now

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

Id in the current organization.

Response

Operation result.

Send/approve/retry receipt; id/title/schedule fields depend on operation. Successful queueing does not prove provider acceptance or inbox delivery.

message
string
Example:

"News letter is being sent"

status
enum<string>
Available options:
draft,
scheduled,
sending,
sent,
failed,
skipped
Example:

"sending"

id
integer

Organization-owned record identifier.

Example:

42

title
string
Example:

"Education field update"

scheduled_at
string<date-time> | null
Example:

"2026-10-20T12:00:00Z"

timezone
string | null
Example:

"Africa/Kampala"

scheduled_timezone
string | null
Example:

"Africa/Kampala"

schedule_source
string | null
Example:

"calendar"

recipient_count
integer

Count.

Required range: x >= 0
Example:

1

eligible_recipient_count
integer | null

Null while eligibility is deferred for audiences larger than500.

Required range: x >= 0
Example:

1

suppressed_recipient_count
integer | null

Null while eligibility is deferred for audiences larger than500.

Required range: x >= 0
Example:

0

recipient_eligibility_pending
boolean

Present and true only when eligibility is deferred.

Example:

true