Skip to main content
POST
/
clients
/
{id}
/
custom-fields
Set Client Custom Field Value
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/custom-fields \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "custom_field_id": "<string>",
  "value": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "value": "<string>",
  "field_type": "<string>",
  "options": [
    {
      "title": "<string>",
      "value": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt

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

This endpoint sets a value on an existing company-wide custom field for a specific client — it does not create a new field definition. Custom field definitions are managed at the company level.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Body

application/json

Custom field ID and the value to set.

​
custom_field_id
string
required

The company-wide custom field definition ID.

​
value
string

The value to set for this client.

Response

OK

A custom field with its value for a specific client.

​
id
string

Custom field definition ID.

​
name
string

Custom field name.

​
value
string | null

The value set for this client.

​
field_type
string

Field type (e.g., text, dropdown, checkbox).

​
options
object[]

Available options for dropdown/select fields.