Skip to main content
POST
Preview your account's wording for one email

Authorizations

X-Auth-Token
string
header
required

Your access token (raw token, no Bearer prefix)

Path Parameters

eventType
enum<string>
required

The email, by the event name its webhook delivery events carry, as listed by the list operation: PayslipGeneratedEvent, P45GeneratedEvent, P60GeneratedEvent, EmployeePensionEnrolmentEvent, ReportReadyEvent, WebhookEndpointFailingEvent, WebhookEndpointDisabledEvent, UserInvitedEvent, EmailVerificationEvent, PasswordResetEvent, SecurityAlertEvent.

Available options:
PayslipGeneratedEvent,
P45GeneratedEvent,
P60GeneratedEvent,
EmployeePensionEnrolmentEvent,
ReportReadyEvent,
WebhookEndpointFailingEvent,
WebhookEndpointDisabledEvent,
UserInvitedEvent,
EmailVerificationEvent,
PasswordResetEvent,
SecurityAlertEvent

Body

Absent: keep. null: clear and inherit. Text: set.

subject
string | null
heading
string | null
intro
string | null
closing
string | null
buttonLabel
string | null
enabled
boolean | null

false: switch the email off. true: on. null: follow the account.

Response

OK

message
object
required
validationIssues
object[] | null
content
object