Skip to content

Update a email-preference

PUT
/email-preferences/{id}
id
required
string

DocumentId

object
data
object
user
One of:

DocumentId reference to plugin::users-permissions.user

string
product_updates

Feature announcements, changelog digests. Opt-out allowed.

boolean
marketing

Promotional content, upsell nudges, trial/usage-limit nudge emails. Opt-out allowed.

boolean
digest

Periodic summary emails (weekly/monthly usage digest). Opt-out allowed.

boolean
updated_via

Last channel that changed this record — settings UI, one-click unsubscribe link, or auto-created default.

string
Allowed values: settings unsubscribe_link system_default

Updated

object
data
object
user
One of:

DocumentId reference to plugin::users-permissions.user

string
product_updates

Feature announcements, changelog digests. Opt-out allowed.

boolean
marketing

Promotional content, upsell nudges, trial/usage-limit nudge emails. Opt-out allowed.

boolean
digest

Periodic summary emails (weekly/monthly usage digest). Opt-out allowed.

boolean
updated_via

Last channel that changed this record — settings UI, one-click unsubscribe link, or auto-created default.

string
Allowed values: settings unsubscribe_link system_default
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Validation error

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found