Skip to main content
POST
Preview an organisation's email as it would be sent

Authorizations

X-Auth-Token
string
header
required

Your access token (raw token, no Bearer prefix)

X-Org-Id
string
header
required

The organisation to act on. Required only when your credentials can reach more than one organisation; optional for a single organisation.

Path Parameters

organisationId
string
required

The organisation to act on. It must be the one selected with X-Org-Id: a request naming two different organisations is refused with 403.

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.

Available options:
PayslipGeneratedEvent,
P45GeneratedEvent,
P60GeneratedEvent,
EmployeePensionEnrolmentEvent,
ReportReadyEvent,
WebhookEndpointFailingEvent,
WebhookEndpointDisabledEvent

Body

application/json

Both optional: no body previews what is saved, in the published brand.

wording
object | null

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

brand
enum<string>
default:Live
Available options:
Live,
Draft

Response

OK

message
object
required
validationIssues
object[] | null
content
object