Create a custom field value
Platform module
POST/custom-field-valuescustomFieldValues.create
A custom field value for one row. Creates a custom field value. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability work.record.write.
- OAuth scopes: work.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: CustomFieldValueCreate
| Field | Type | Required | Description |
|---|---|---|---|
| custom_field_definition_id | string (uuid) | Yes | Identifier of the custom field definition. |
| value_text | string | number | boolean | null | No | Typed value. |
| target_id | string (uuid) | Yes | Identifier of the row of the field's target table the value belongs to. |
| value_number | number | null | No | Number value. |
| value_money_minor | integer (int64) | null | No | Money value in minor units of value_currency. Integer minor units of the resource currency; null means unpriced, never zero. |
| value_currency | string | null | No | ISO 4217 currency of a money value.Constraints: pattern ^[A-Z]{3}$ |
| value_date | string (date) | null | No | Date value. |
| value_timestamp | string (date-time) | null | No | Timestamp value. |
| value_boolean | boolean | null | No | Boolean value. |
| value_choice_id | string (uuid) | null | No | Identifier of the chosen option of the field. |
| value_person_id | string (uuid) | null | No | Identifier of the person value. |
{
"custom_field_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_text": true,
"target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_number": 12.5,
"value_money_minor": 250000,
"value_currency": "USD",
"value_date": "2026-10-08",
"value_timestamp": "2026-10-08T14:30:00Z",
"value_boolean": true,
"value_choice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: CustomFieldValue
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the custom field value. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| custom_field_definition_id | string (uuid) | Yes | Identifier of the custom field definition. |
| value_text | string | number | boolean | null | Yes | Typed value. |
| target_id | string (uuid) | Yes | Identifier of the row of the field's target table the value belongs to. |
| value_number | number | null | Yes | Number value. |
| value_money_minor | integer (int64) | null | Yes | Money value in minor units of value_currency. Integer minor units of the resource currency; null means unpriced, never zero. |
| value_currency | string | null | Yes | ISO 4217 currency of a money value.Constraints: pattern ^[A-Z]{3}$ |
| value_date | string (date) | null | Yes | Date value. |
| value_timestamp | string (date-time) | null | Yes | Timestamp value. |
| value_boolean | boolean | null | Yes | Boolean value. |
| value_choice_id | string (uuid) | null | Yes | Identifier of the chosen option of the field. |
| value_person_id | string (uuid) | null | Yes | Identifier of the person value. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"custom_field_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_text": true,
"target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_number": 12.5,
"value_money_minor": 250000,
"value_currency": "USD",
"value_date": "2026-10-08",
"value_timestamp": "2026-10-08T14:30:00Z",
"value_boolean": true,
"value_choice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/custom-field-values" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"custom_field_definition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value_text":true,"target_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value_number":12.5,"value_money_minor":250000,"value_currency":"USD","value_date":"2026-10-08","value_timestamp":"2026-10-08T14:30:00Z","value_boolean":true,"value_choice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.customFieldValues.create({
"custom_field_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_text": true,
"target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_number": 12.5,
"value_money_minor": 250000,
"value_currency": "USD",
"value_date": "2026-10-08",
"value_timestamp": "2026-10-08T14:30:00Z",
"value_boolean": true,
"value_choice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"value_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.custom_field_values.create({"custom_field_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "value_text": True, "target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "value_number": 12.5, "value_money_minor": 250000, "value_currency": "USD", "value_date": "2026-10-08", "value_timestamp": "2026-10-08T14:30:00Z", "value_boolean": True, "value_choice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "value_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos custom-field-values create --data '{"custom_field_definition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value_text":true,"target_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value_number":12.5,"value_money_minor":250000,"value_currency":"USD","value_date":"2026-10-08","value_timestamp":"2026-10-08T14:30:00Z","value_boolean":true,"value_choice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","value_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'