Skip to main content
POST
Save newsletter content and audience

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

from
string<email>
required

Recorded actor/sender email; actual delivery uses organization email settings.

Example:

"admin@example.org"

message
string
required

Newsletter HTML; saved Impact Story evidence is checked when present.

Example:

"<p>Thank you for supporting education.</p>"

title
string
required
Example:

"Education field update"

status
string
required

Stored lifecycle value consumed directly by this legacy save handler.

Example:

"draft"

to
integer[] | null

Legacy/manual donor ids; selects server-owned current addresses when audience intent is present.

Organization-owned record identifier.

emails
string<email>[] | null

Explicit email audience only when no server-resolved audience intent is supplied.

tag
string | null

Legacy comma-separated tag selection; tags/audience_selection take priority.

Example:

"Education"

tags
string[] | null
audience_selection
object | null

Server-resolved audience intent. all snapshots all active donors with nonblank email; static unions current ANY-tag matches with additions minus exclusions; manual uses individual ids. Unknown/non-tenant/no-email ids are omitted.

select_all_donors
boolean | null

Overrides other selection fields with an all-donor snapshot.

Example:

false

design
any | null

Editor design object or serialized string; persisted as text.

attachment
string | null

Existing attachment reference; no multipart upload is performed.

Example:

"https://example.org/newsletter.pdf"

fileName
string | null

Legacy attachment alias; attachment takes priority.

Example:

"https://example.org/newsletter.pdf"

log_activity
boolean | null

Record draft activity when true.

Example:

false

Response

Operation result.

Read/edit/audience-save payload. message is included only after mutations; detail includes at most the first50 recipient ids.

data
object

Derived delivery results; sent means provider acceptance, separate from delivered confirmation.

donors
object[]
recipient_pagination
object
audience
object | null

Snapshot-versus-current tag facts. All/manual fresh mode omits tag facts; legacy or manual selections can return null.

status
string
Example:

"success"

message
string
Example:

"Newsletter successfully updated"