Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Custom properties

Update custom property

Update an existing custom property.

put/v1/custom-properties/{id}

Path parameters

idstring required

Request body

namestring required
type'date' | 'boolean' | 'number' | 'text' | 'select' | 'multi_select' required
slugstring required
entitiesstring[] required
api_onlyboolean nullable
requiredboolean nullable
authorized_valuesstring[] nullable

Response

idstring required

Custom property ID.

namestring required

Custom property name.

slugstring required

Custom property unique slug.

type'date' | 'boolean' | 'number' | 'text' | 'select' | 'multi_select' required

Custom property type.

entitiesstring[] required

Entities on which the custom property is available.

authorized_valuesstring[] nullable required

If the custom property is of type select this is the list of available values.

api_onlyboolean

If true the custom property will not be displayed in the interface.

requiredboolean

If true the custom property must be filled for every configured entity.

created_atstring date-time required

Creation date of the custom property.

updated_atstring date-time required

Update date of the custom property.

Example response

{
  "id": "cfi_efnjehRH304",
  "name": "Test custom property",
  "slug": "test_custom_property",
  "created_at": "2024-01-01T22:00:00Z",
  "updated_at": "2024-01-01T22:00:00Z"
}