Skip to main content

Preview invitation

Renders the invitation email as it would be sent now, in the station's saved wording, with sample values in place of a real link, inviter and date

GET /settings/mail/invitation/preview

note

SDK method: previewInvitation Security: authenticated (policy: platform.manage)

Attributes​

Attributes (1)
AttributeTypeRequiredDescription
role'listener' | 'admin'YesThe role the invitation would be for. Its subject, its guide link and the station's own wording differ between the two

Response​

200 OK — Returns a InvitationPreview object.