Developers
Custom fields

Retrieve a custom field

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

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.

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/settings/user-profile/custom-fields/string"
{  "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"  }}

Create a custom field POST

Creates a custom field definition for user profiles in the current account.

Update a custom field PATCH

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.