Skip to main content
PATCH
Update donor communication preferences

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.

email_categories
object

Partial category-key to boolean map; account_security must remain true.

postal_mail_enabled
boolean

Postal mail enabled. Validation: sometimes, boolean.

Example:

true

sms_enabled
boolean

Sms enabled. Validation: sometimes, boolean.

Example:

true

Sms consent confirmed. Validation: sometimes, boolean.

Example:

true

do_not_email
boolean

Do not email. Validation: sometimes, boolean.

Example:

true

restore_email_delivery
boolean

Restore email delivery. Validation: sometimes, boolean.

Example:

true

Response

Operation result.

Effective values and saved choices are separate while a donor master block pauses delivery.

email_categories
object[]
saved_email_categories
object[]
sms
object

Effective delivery state. events and partially_enabled appear when applicable; null blocked_reason can accompany an opt-out.

saved_sms
object

Effective delivery state. events and partially_enabled appear when applicable; null blocked_reason can accompany an opt-out.

postal_mail
object

Effective delivery state. events and partially_enabled appear when applicable; null blocked_reason can accompany an opt-out.

saved_postal_mail
object

Effective delivery state. events and partially_enabled appear when applicable; null blocked_reason can accompany an opt-out.

do_not_email
boolean

Enabled state.

Example:

true