Developers
Users

Update user custom field values

PUT/users/{user_id}/custom-fields

Sets custom field values for the user. Send a values object keyed by custom field public ID. Custom fields not included in the request keep their current values.

Values are validated against the field type: number fields require a numeric value and date fields require the YYYY-MM-DD format. Invalid values return validation_failed, with the affected field identified in details[].field.

If custom fields are not enabled for the account, the API returns feature_disabled.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/users/string/custom-fields" \  -H "Content-Type: application/json" \  -d '{    "values": {}  }'
{}

List user custom field values GET

Returns the user's custom field values, keyed by custom field public ID. If custom fields are not enabled for the account, the API returns `feature_disabled`.

Delete a custom field value DELETE

Clears the user's value for a custom field. The custom field itself is not affected. The operation is idempotent: clearing a value that is not set also succeeds.