Developers
Custom fields5

Update a custom field

PATCH/settings/user-profile/custom-fields/{custom_field_id}

Updates a custom field definition. Fields omitted from the request keep their current values.

The type of a field cannot be changed once users have filled in values for it. Such requests return the state_conflict error code.

To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header.

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

custom_field_id*string

Public ID of the custom field, prefixed with cfd_.

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

application/json

curl -X PATCH "https://example.com/settings/user-profile/custom-fields/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "label": "string",    "object": "custom_field",    "position": 0,    "required": true,    "revision": "string",    "type": "text",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a custom field GET

Retrieves a custom field definition by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the custom field to avoid overwriting a newer version.

Delete a custom field DELETE

Deletes a custom field definition. Only the definition is removed. Values that users have already filled in for this field are retained but are no longer returned with the user's custom field values.