List an organisation's email wording
Every email whose wording an organisation can change, each with who receives it (audience), whether it is sent (enabled) and can be switched off, what this organisation has set (wording), what applies where it sets nothing (inherited: its account’s wording, then the standard wording), the standard wording, the placeholders it may use with their sample values, whether it shows a button, what it always includes (locked) and who last saved it. The sign-in emails are set for the whole account only.
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings"
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings', 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/organisations/{organisationId}/email-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <api-key>",
"X-Org-Id: <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"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
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>",
"level": "Organisation",
"audience": "Employees",
"enabled": true,
"canBeSwitchedOff": true,
"wording": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
},
"inherited": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
},
"standard": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
},
"placeholders": [
{
"key": "<string>",
"sample": "<string>"
}
],
"hasButton": true,
"locked": [
"<string>"
],
"updatedDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"standardFromAddress": "<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>"
}
]
}
]
}Authorizations
Your access token (raw token, no Bearer prefix)
The organisation to act on. Required only when your credentials can reach more than one organisation; optional for a single organisation.
Path Parameters
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.
Was this page helpful?
curl --request GET \
--url https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings"
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings', 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/organisations/{organisationId}/email-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <api-key>",
"X-Org-Id: <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"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/notification-settings/organisations/{organisationId}/email-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
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>",
"level": "Organisation",
"audience": "Employees",
"enabled": true,
"canBeSwitchedOff": true,
"wording": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
},
"inherited": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
},
"standard": {
"subject": "<string>",
"heading": "<string>",
"intro": "<string>",
"closing": "<string>",
"buttonLabel": "<string>"
},
"placeholders": [
{
"key": "<string>",
"sample": "<string>"
}
],
"hasButton": true,
"locked": [
"<string>"
],
"updatedDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"standardFromAddress": "<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>"
}
]
}
]
}