Skip to main content
POST
Save preferences from a signed email link

Body

application/json

Validated request fields for this operation.

token
string
required

Token. Validation: required, string, max:4096.

Maximum string length: 4096
Example:

"signed-link-token"

disable_email_categories
enum<string>[]

Disable email categories. Validation: sometimes, array.

Disable email categories item. Validation: string, max:100.

Available options:
marketing,
receipts_tax,
payment_issues,
sponsorship_updates,
events_fundraising,
messages,
files_photos,
other_updates
Maximum string length: 100
enable_email_categories
enum<string>[]

Enable email categories. Validation: sometimes, array.

Enable email categories item. Validation: string, max:100.

Available options:
marketing,
receipts_tax,
payment_issues,
sponsorship_updates,
events_fundraising,
messages,
files_photos,
other_updates
Maximum string length: 100
disable_sms
boolean

Accepted only as false; true is rejected because this signed link controls email only.

Example:

true

disable_postal_mail
boolean

Accepted only as false; true is rejected because this signed link controls email only.

Example:

true

disable_all_email
boolean

Disable all email. Validation: sometimes, boolean.

Example:

true

restore_all_email
boolean

Restore all email. Validation: sometimes, boolean.

Example:

true

Response

Operation result.

message
string
Example:

"Email preferences saved."

organization
object
tokens
object
source_category_key
enum<string> | null
Available options:
marketing,
account_security,
receipts_tax,
payment_issues,
sponsorship_updates,
events_fundraising,
messages,
files_photos,
other_updates,
null
Example:

"marketing"

True for a whole-email legacy signed link.

Example:

true

email_categories
object[]