Developers
Custom fields5

Create a custom field

POST/settings/user-profile/custom-fields

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

Authorization

AuthorizationBearer <token>

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

In: header

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._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. 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

curl -X POST "https://example.com/settings/user-profile/custom-fields" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "label": "string",    "type": "text"  }'
{  "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"  }}

List custom fields GET

Lists the custom field definitions available for user profiles in the current account. Returns all definitions in a single response, ordered by `position`.

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.