Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Custom Fields

Create a custom field for customers

Create a new custom field to be used in the customer schema.

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

post/v2/customers/custom-fields

Request body

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

The type of data stored in a custom field.

display_namestring required
keystring required

Response

Custom field created successfully.

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