FAfactorialhr
Timeoff > Policy

Creates a Policy

Changed on

Creates a Policy

post/api/2026-10-01/resources/timeoff/policies

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/timeoff/policies
  • 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

Request body

namestring required

The name of the policy.

mainboolean

If the policy is the main policy.

descriptionstring

Policy description.

company_idstring

Company ID.

based_on_policy_idstring

ID of an existing policy to copy. When set, the new policy is created with a copy of that policy's allowances and no employees assigned. Omit it to create a policy from scratch.

Example request

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

Response

CREATED

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