Starters & leavers
Set leaver details for many employees in one call
Marks each listed employee as a leaver in one request. The defaults block applies to every entry; any entry may override any field (leavingDate, reason, issuedBy) for that employee. Each successful entry fires its own per-employee leaver-update SNS event so downstream consumers (P45 module, payslip pipeline) need no awareness of bulk operations. The response always returns 200 with a structured envelope of succeeded and failed identifiers.
PUT
/
employees
/
leaver
/
bulk
Set leaver details for many employees in one call
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"defaults": {
"leavingDate": "2026-05-30",
"reason": "Resignation"
},
"entries": [
{
"employeeId": "emp_12345",
"leavingDate": "2026-06-15",
"reason": "Retirement"
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk"
payload = {
"defaults": {
"leavingDate": "2026-05-30",
"reason": "Resignation"
},
"entries": [
{
"employeeId": "emp_12345",
"leavingDate": "2026-06-15",
"reason": "Retirement"
}
]
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
defaults: {leavingDate: '2026-05-30', reason: 'Resignation'},
entries: [{employeeId: 'emp_12345', leavingDate: '2026-06-15', reason: 'Retirement'}]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk', 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/employees/leaver/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'defaults' => [
'leavingDate' => '2026-05-30',
'reason' => 'Resignation'
],
'entries' => [
[
'employeeId' => 'emp_12345',
'leavingDate' => '2026-06-15',
'reason' => 'Retirement'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk"
payload := strings.NewReader("{\n \"defaults\": {\n \"leavingDate\": \"2026-05-30\",\n \"reason\": \"Resignation\"\n },\n \"entries\": [\n {\n \"employeeId\": \"emp_12345\",\n \"leavingDate\": \"2026-06-15\",\n \"reason\": \"Retirement\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"defaults\": {\n \"leavingDate\": \"2026-05-30\",\n \"reason\": \"Resignation\"\n },\n \"entries\": [\n {\n \"employeeId\": \"emp_12345\",\n \"leavingDate\": \"2026-06-15\",\n \"reason\": \"Retirement\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaults\": {\n \"leavingDate\": \"2026-05-30\",\n \"reason\": \"Resignation\"\n },\n \"entries\": [\n {\n \"employeeId\": \"emp_12345\",\n \"leavingDate\": \"2026-06-15\",\n \"reason\": \"Retirement\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"succeeded": [
"<string>"
],
"failed": [
{
"employeeId": "emp_67890",
"reason": "leaver_reported_to_hmrc"
}
]
},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}Authorizations
Access token obtained from OAuth2 client credentials flow
Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).
Body
application/json
Was this page helpful?
⌘I
Set leaver details for many employees in one call
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"defaults": {
"leavingDate": "2026-05-30",
"reason": "Resignation"
},
"entries": [
{
"employeeId": "emp_12345",
"leavingDate": "2026-06-15",
"reason": "Retirement"
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk"
payload = {
"defaults": {
"leavingDate": "2026-05-30",
"reason": "Resignation"
},
"entries": [
{
"employeeId": "emp_12345",
"leavingDate": "2026-06-15",
"reason": "Retirement"
}
]
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
defaults: {leavingDate: '2026-05-30', reason: 'Resignation'},
entries: [{employeeId: 'emp_12345', leavingDate: '2026-06-15', reason: 'Retirement'}]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk', 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/employees/leaver/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'defaults' => [
'leavingDate' => '2026-05-30',
'reason' => 'Resignation'
],
'entries' => [
[
'employeeId' => 'emp_12345',
'leavingDate' => '2026-06-15',
'reason' => 'Retirement'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk"
payload := strings.NewReader("{\n \"defaults\": {\n \"leavingDate\": \"2026-05-30\",\n \"reason\": \"Resignation\"\n },\n \"entries\": [\n {\n \"employeeId\": \"emp_12345\",\n \"leavingDate\": \"2026-06-15\",\n \"reason\": \"Retirement\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"defaults\": {\n \"leavingDate\": \"2026-05-30\",\n \"reason\": \"Resignation\"\n },\n \"entries\": [\n {\n \"employeeId\": \"emp_12345\",\n \"leavingDate\": \"2026-06-15\",\n \"reason\": \"Retirement\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/employees/leaver/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaults\": {\n \"leavingDate\": \"2026-05-30\",\n \"reason\": \"Resignation\"\n },\n \"entries\": [\n {\n \"employeeId\": \"emp_12345\",\n \"leavingDate\": \"2026-06-15\",\n \"reason\": \"Retirement\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"succeeded": [
"<string>"
],
"failed": [
{
"employeeId": "emp_67890",
"reason": "leaver_reported_to_hmrc"
}
]
},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {},
"metadata": {
"dateFormat": "yyyy-MM-dd",
"dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"messageToken": "<string>"
}