FAfactorialhr
CustomFields > Value

Creates a Value

Changed on

Creates a Value

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

Request

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

field_idstring required

Custom Fields identifier

valuable_typestring required

Type of the object that the custom field is attached to: 'Document' | 'Employee' | 'Contracts::ContractVersion' | 'CustomResources::Value'

valuable_idstring required

Identifier of the object that the custom field is attached to

valuestring required

Custom Fields value

Example request

{
  "field_id": "1",
  "valuable_type": "Employee",
  "valuable_id": "1",
  "value": "This is an example value for a custom field"
}

Response

CREATED

idstring required

Unique identifier for the custom field value

valuestring

Custom Fields value

long_text_valuestring

Custom field text value

custom_field_identifierstring required

The unique identifier of the custom field

date_valuestring

Custom field date value

single_choice_valuestring

Custom field single choice value

cents_valueinteger

Custom field number value

valuable_idstring required

The identifier of the object that owns this custom field value

field_idstring required

The identifier of the custom field

valuable_typestring required

The type of the object that owns this custom field value

labelstring

The label of the custom field

requiredboolean

Whether the custom field is required

usage_group_idstring

The identifier of the usage group

usage_group_slugstring

The slug of the usage group

updated_atstring

The date and time the custom field value was last updated.

Example response

{
  "id": "73",
  "value": "1235436",
  "long_text_value": "1235436",
  "custom_field_identifier": "01f931507aa27e1168025e27cd46b8588435b741",
  "date_value": "2024-10-06",
  "single_choice_value": "Option 1",
  "cents_value": 100,
  "valuable_id": "18",
  "field_id": "75",
  "valuable_type": "Employee",
  "label": "Matricule",
  "required": true,
  "usage_group_id": "37",
  "usage_group_slug": "employees-questions",
  "updated_at": "2024-10-06T00:00:00.000Z"
}

Changes