Skip to navigation
API ReferenceIntegrations & AutomationEventsEmail Subscription

Activate email subscription

This endpoint sets 'isActive' to true.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequiredformat: "uuid"

Response

Successfully activated
idstringOptionalformat: "uuid"
Unique ID of the subscription
namestringOptional
Unique name of the subscription
eventTypeslist of stringsOptional
List of event types subscribed to. Always contains at least one type.
subjectstringOptional

Email subject line. Supports {{placeholder}} tokens resolved from the event payload at send time.

previewTextstringOptional
Short preview text shown by mail clients next to the subject.
emailTemplatestringOptional

Request-specific HTML fragment (title, body, CTA) rendered inside the shared email shell at send time.

recipientslist of stringsOptional

Recipients of the email. Each entry is either a literal address, a user reference {{u::<payload-field>}}, or a group reference {{g::<payload-field>}}.

isActivebooleanOptional
Whether the subscription is active
descriptionstringOptional
Optional description
createdTimestringOptionalformat: "date-time"
Time when the subscription was created
updatedTimestringOptionalformat: "date-time"
Time when the subscription was last updated
createdBystringOptional
Username of the user who created the subscription
updatedBystringOptional
Username of the user who last updated the subscription

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
5XX
Server Error