Developers
Users38

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

Public ID of the user, prefixed with usr_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

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

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": {}  }'
{  "data": {    "object": "user_custom_fields",    "values": {}  }}

List user custom field values GET

Returns the user's custom field values, keyed by custom field public ID. Values of deleted custom fields are not included. 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.