FAfactorialhr
CustomFields > Option

Creates an Option

Changed on

Creates an Option

post/api/2026-10-01/resources/custom_fields/options

Request

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

Request body

labelstring required

Title for option

is_activeboolean

Flag to make the option available

field_idstring required

Custom Fields identifier

Example request

{
  "label": "T-shirt size",
  "is_active": true,
  "field_id": "2"
}

Response

CREATED

idstring required

Option identifier

labelstring

Title for option

valuestring

Option value

is_activeboolean

Flag to make the option available

field_idstring

Custom Fields identifier

Example response

{
  "id": "1",
  "label": "T-shirt size",
  "value": "L",
  "is_active": true,
  "field_id": "2"
}

Changes