Skip to content
Letterhead Letterhead Letterhead Help Center
Admin Tools

Update an automation notification email preference

PUT
/api/v3/automations/email-preferences
curl --request PUT \
--url https://api.tryletterhead.com/api/v3/automations/email-preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form channelId=1 \
--form eventSlug=automation_deactivated \
--form enabled=true

Subscribe or unsubscribe the signed-in user from one notification eventโ€™s emails. See the matching GET endpoint above for the full list of accepted eventSlug values. The choice is always stored as a row (never deleted), so it stays distinguishable from โ€œnever choseโ€ and can turn off an event thatโ€™s on by default.

This changes the current userโ€™s own preference, so it authenticates as a signed-in user rather than a company API key and is not available to external integrations.

Media type multipart/form-data
object
channelId
required

The internal numeric id of the channel the notification is scoped to.

integer
eventSlug
required

The notification event, e.g. automation_deactivated or automation_template_reactivated.

string
Allowed values: automation_deactivated automation_template_reactivated import_success_failure export_success_failure email_sent review_requested ai_text_failed new_comments duplicate_email_detected rss_feed_failure system_failure webhook_failure goal_reached analyze_agent_finished newsletter_not_sent sending_domain_warmup standing_task_finished
enabled
required

Whether the user should receive this notification by email.

boolean

200 OK

Media type application/json
object
items
string
nullable
message
string
total
integer
Example
{
"items": null,
"message": "Preference updated successfully.",
"total": 0
}

Still can’t find what you need? Contact support.