Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Custom Fields

Update customer custom fields

Update the display name for a custom field.

You need the "Manage customer custom fields" permission to use this endpoint.

patch/v2/customers/custom-fields/{custom_field_identifier}

Path parameters

custom_field_identifierstring uuid required

The unique identifier we provided when you created the customer custom field.

Request body

display_namestring required

Response

Success. The custom field is updated.

customer_type'PERSON' | 'COMPANY' required
data_type'TEXT' | 'INTEGER' | 'DECIMAL' | 'DATE' | 'DATETIME' required

The type of data stored in a custom field.

display_namestring required
identifierstring uuid required
keystring required