Organisation defaults
Update auto-enrolment settings
Sets the organisation’s auto-enrolment mode.
PUT
/
organisation
/
pension-default
/
auto-enrolment-settings
Update auto-enrolment settings
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings \
--header 'Content-Type: application/json' \
--data '
{
"sendEnrolmentLetterOnAutoEnrolment": true,
"employerIssuesEnrolmentInformation": true,
"reEnrolRecentOptOuts": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings"
payload = {
"sendEnrolmentLetterOnAutoEnrolment": True,
"employerIssuesEnrolmentInformation": True,
"reEnrolRecentOptOuts": True
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
sendEnrolmentLetterOnAutoEnrolment: true,
employerIssuesEnrolmentInformation: true,
reEnrolRecentOptOuts: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-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/v2/pension/organisation/pension-default/auto-enrolment-settings",
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([
'sendEnrolmentLetterOnAutoEnrolment' => true,
'employerIssuesEnrolmentInformation' => true,
'reEnrolRecentOptOuts' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/v2/pension/organisation/pension-default/auto-enrolment-settings"
payload := strings.NewReader("{\n \"sendEnrolmentLetterOnAutoEnrolment\": true,\n \"employerIssuesEnrolmentInformation\": true,\n \"reEnrolRecentOptOuts\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
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/v2/pension/organisation/pension-default/auto-enrolment-settings")
.header("Content-Type", "application/json")
.body("{\n \"sendEnrolmentLetterOnAutoEnrolment\": true,\n \"employerIssuesEnrolmentInformation\": true,\n \"reEnrolRecentOptOuts\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"sendEnrolmentLetterOnAutoEnrolment\": true,\n \"employerIssuesEnrolmentInformation\": true,\n \"reEnrolRecentOptOuts\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"organisationId": "<string>",
"defaultPensionGroupId": "<string>",
"defaultPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"pensionType": "ReliefAtSource",
"basis": "Pensionable",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"contributionType": "Percentage",
"employeeFixedAmount": 123,
"employerFixedAmount": 123,
"externalReferenceId": "<string>"
},
"defaultPostponementStartDateDefinition": {
"value": 123,
"frequency": "Days"
},
"defaultPostponementEligibilityDateDefinition": {
"value": 123,
"frequency": "Days"
},
"autoEnrolmentMode": "None",
"sendEnrolmentLetterOnAutoEnrolment": true,
"employerIssuesEnrolmentInformation": true,
"reEnrolRecentOptOuts": true,
"enrolmentInformationDeclaredBy": "<string>",
"enrolmentInformationDeclaredDate": "2023-12-25"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}Body
application/json
Available options:
None, Manual, Automatic Optional. When omitted/null the organisation's current value is left unchanged. True makes Flow email the enrolment letter as part of automatically enrolling somebody, which is the cohort that holds the statutory opt-out right and so the one whose letter date decides refunds.
Optional. When omitted/null the organisation's current value is left unchanged. True is the employer declaring that THEY give workers the enrolment information, by post or their own systems, rather than relying on Flow's email. It is a statement about their own compliance with the information duty, so the caller is recorded against it; who and when are stamped by the service and are not accepted from the request.
Optional. When omitted/null the organisation's current value is left unchanged. True re-enrols workers who opted out or ceased membership at their own request in the 12 months before the automatic re-enrolment date, which TPR DG11 para 30 leaves to the employer to decide. False (the default) excludes them from that cycle; either way they are assessed again at the next one.
Response
OK
The response envelope every FlowPayroll API answers with: a message, the
content, and any validationIssues. errors and the top-level
metadata are deprecated copies of validationIssues and
content.metadata, and will be removed.
What happened, as English text and a stable token to translate from.
textId and textParameters are deprecated copies of token and tokenArguments.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Deprecated: the same issues as validationIssues (reasonText is reason, reasonId is reasonToken, reasonParameters is reasonTokenArguments). Read validationIssues; this will be removed.
Show child attributes
Show child attributes
Deprecated: the same values as content.metadata. Read that; this will be removed.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update auto-enrolment settings
curl --request PUT \
--url https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings \
--header 'Content-Type: application/json' \
--data '
{
"sendEnrolmentLetterOnAutoEnrolment": true,
"employerIssuesEnrolmentInformation": true,
"reEnrolRecentOptOuts": true
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings"
payload = {
"sendEnrolmentLetterOnAutoEnrolment": True,
"employerIssuesEnrolmentInformation": True,
"reEnrolRecentOptOuts": True
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
sendEnrolmentLetterOnAutoEnrolment: true,
employerIssuesEnrolmentInformation: true,
reEnrolRecentOptOuts: true
})
};
fetch('https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-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/v2/pension/organisation/pension-default/auto-enrolment-settings",
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([
'sendEnrolmentLetterOnAutoEnrolment' => true,
'employerIssuesEnrolmentInformation' => true,
'reEnrolRecentOptOuts' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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/v2/pension/organisation/pension-default/auto-enrolment-settings"
payload := strings.NewReader("{\n \"sendEnrolmentLetterOnAutoEnrolment\": true,\n \"employerIssuesEnrolmentInformation\": true,\n \"reEnrolRecentOptOuts\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
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/v2/pension/organisation/pension-default/auto-enrolment-settings")
.header("Content-Type", "application/json")
.body("{\n \"sendEnrolmentLetterOnAutoEnrolment\": true,\n \"employerIssuesEnrolmentInformation\": true,\n \"reEnrolRecentOptOuts\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"sendEnrolmentLetterOnAutoEnrolment\": true,\n \"employerIssuesEnrolmentInformation\": true,\n \"reEnrolRecentOptOuts\": true\n}"
response = http.request(request)
puts response.read_body{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": {
"organisationId": "<string>",
"defaultPensionGroupId": "<string>",
"defaultPensionGroup": {
"id": "<string>",
"organisationId": "<string>",
"pensionSchemaId": "<string>",
"name": "<string>",
"isDefault": true,
"pensionType": "ReliefAtSource",
"basis": "Pensionable",
"employeeFactor": 123,
"employerFactor": 123,
"nationalInsuranceSavingsFactor": 123,
"createdBy": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isSalarySacrifice": true,
"contributionType": "Percentage",
"employeeFixedAmount": 123,
"employerFixedAmount": 123,
"externalReferenceId": "<string>"
},
"defaultPostponementStartDateDefinition": {
"value": 123,
"frequency": "Days"
},
"defaultPostponementEligibilityDateDefinition": {
"value": 123,
"frequency": "Days"
},
"autoEnrolmentMode": "None",
"sendEnrolmentLetterOnAutoEnrolment": true,
"employerIssuesEnrolmentInformation": true,
"reEnrolRecentOptOuts": true,
"enrolmentInformationDeclaredBy": "<string>",
"enrolmentInformationDeclaredDate": "2023-12-25"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}{
"message": {
"token": "<string>",
"text": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
],
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
],
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
}