Account emails
Preview your account's wording for one email
The wording that would be sent, filled with sample values. Send an unsaved draft to preview it, or no body to preview what is saved. Nothing is saved or sent.
POST
/
customer
/
email-settings
/
{eventType}
/
previews
Preview your account's wording for one email
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews \
--header 'Content-Type: application/merge-patch+json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>",
"enabled": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews"
payload = {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>",
"enabled": True
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/merge-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/merge-patch+json'},
body: JSON.stringify({
subject: '<string>',
heading: '<string>',
intro: '<string>',
closing: '<string>',
buttonLabel: '<string>',
enabled: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subject' => '<string>',
'heading' => '<string>',
'intro' => '<string>',
'closing' => '<string>',
'buttonLabel' => '<string>',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/merge-patch+json",
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews"
payload := strings.NewReader("{\n \"subject\": \"<string>\",\n \"heading\": \"<string>\",\n \"intro\": \"<string>\",\n \"closing\": \"<string>\",\n \"buttonLabel\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/merge-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"subject\": \"<string>\",\n \"heading\": \"<string>\",\n \"intro\": \"<string>\",\n \"closing\": \"<string>\",\n \"buttonLabel\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n \"subject\": \"<string>\",\n \"heading\": \"<string>\",\n \"intro\": \"<string>\",\n \"closing\": \"<string>\",\n \"buttonLabel\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
],
"content": {
"data": {
"eventType": "<string>",
"wording": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}Authorizations
Your access token (raw token, no Bearer prefix)
Path Parameters
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
application/merge-patch+jsonapplication/json
Was this page helpful?
⌘I
Preview your account's wording for one email
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews \
--header 'Content-Type: application/merge-patch+json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>",
"enabled": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews"
payload = {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>",
"enabled": True
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/merge-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/merge-patch+json'},
body: JSON.stringify({
subject: '<string>',
heading: '<string>',
intro: '<string>',
closing: '<string>',
buttonLabel: '<string>',
enabled: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subject' => '<string>',
'heading' => '<string>',
'intro' => '<string>',
'closing' => '<string>',
'buttonLabel' => '<string>',
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/merge-patch+json",
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews"
payload := strings.NewReader("{\n \"subject\": \"<string>\",\n \"heading\": \"<string>\",\n \"intro\": \"<string>\",\n \"closing\": \"<string>\",\n \"buttonLabel\": \"<string>\",\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/merge-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"subject\": \"<string>\",\n \"heading\": \"<string>\",\n \"intro\": \"<string>\",\n \"closing\": \"<string>\",\n \"buttonLabel\": \"<string>\",\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/notification-settings/customer/email-settings/{eventType}/previews")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n \"subject\": \"<string>\",\n \"heading\": \"<string>\",\n \"intro\": \"<string>\",\n \"closing\": \"<string>\",\n \"buttonLabel\": \"<string>\",\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
],
"content": {
"data": {
"eventType": "<string>",
"wording": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<unknown>"
}
]
}
]
}