Skip to main content
PATCH
Edit newsletter content or scheduling

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

Id in the current organization.

Body

application/json

Validated request fields for this operation.

from
string<email> | null

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

Example:

"admin@example.org"

message
string | null

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

Example:

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

title
string | null
Example:

"Education field update"

status
enum<string> | null
Available options:
draft,
scheduled,
null
Example:

"draft"

to
integer[] | null

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

Organization-owned record identifier.

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"

scheduled_at
string | null

Legacy local/offset date-time; required for scheduling unless schedule is provided. Must be at least five minutes ahead.

Example:

"2026-10-27T15:00:00"

timezone
string | null

IANA timezone; otherwise stored/account/admin timezone fallback.

Maximum string length: 64
Example:

"Africa/Kampala"

schedule
object

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"