FAfactorialhr
Timeoff > Policy

Updates a Policy

Changed on

Updates a Policy

put/api/2026-10-01/resources/timeoff/policies/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/policies/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_off
    • or API key in header x-api-key

Path parameters

idstring required

Id of the policy to update.

Request body

idstring required

Id of the policy to update.

namestring

The name of the policy.

descriptionstring

Policy description.

mainboolean

If the policy is the main policy.

Example request

{
  "id": "1",
  "name": "Policy for remotes",
  "description": "This policy will apply only for remote employees"
}

Response

OK

idstring required

The policy id.

namestring required

Policy name.

mainboolean

Whether this is the company's main (default) time off policy — the one employees fall under unless assigned a specific policy.

company_idstring required

ID of the company that owns this policy.

descriptionstring

The policy description.

Example response

{
  "id": "1",
  "name": "Policy for remotes",
  "main": true,
  "company_id": "1",
  "description": "This policy will apply only for remote employees"
}

Changes