Skip to main content
PUT
/
organisation
/
pension-default
/
auto-enrolment-settings
cURL
curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v2/pension/organisation/pension-default/auto-enrolment-settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoEnrolmentMode": "<string>"
}
'
{
  "content": {
    "data": {
      "organisationId": "<string>",
      "defaultPensionGroupId": "<string>",
      "defaultPensionGroup": {
        "id": "<string>",
        "organisationId": "<string>",
        "pensionSchemaId": "<string>",
        "name": "<string>",
        "isDefault": true,
        "basis": "<string>",
        "employeeFactor": 123,
        "employerFactor": 123,
        "nationalInsuranceSavingsFactor": 123,
        "createdBy": "<string>",
        "createdDate": "2023-11-07T05:31:56Z",
        "updatedBy": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z",
        "isSalarySacrifice": true
      },
      "defaultPostponementStartDateDefinition": {
        "value": 123,
        "frequency": "<string>"
      },
      "defaultPostponementEligibilityDateDefinition": {
        "value": 123,
        "frequency": "<string>"
      },
      "autoEnrolmentMode": "<string>"
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
autoEnrolmentMode
string | null
required

Response

200 - application/json

OK

content
object
metadata
object
errors
object[] | null
message
object