v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Custom Entity

Update Custom Entity

Update an existing custom entity

patch/custom_entity

Query parameters

selectstring

Select columns to return

idstring

Entity ID

created_atstring

Creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

custom_entity_definition_idstring

Custom entity definition ID

contact_idstring

Contact ID

external_idstring

External ID

datastring

Entity data matching the custom entity definition schema

Request body

idstring uuid

Entity ID

created_atstring timestamp with time zone

Creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

custom_entity_definition_idstring uuid

Custom entity definition ID

contact_idstring uuid

Contact ID

external_idstring text nullable

External ID

dataobject

Entity data matching the custom entity definition schema

custom_entity_definition_keystring text

Key of the custom entity definition. Alternative to custom_entity_definition_id.

Response

The updated Custom Entity object

idstring uuid

Entity ID

created_atstring timestamp with time zone

Creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

custom_entity_definition_idstring uuid

Custom entity definition ID

contact_idstring uuid

Contact ID

external_idstring text nullable

External ID

dataobject

Entity data matching the custom entity definition schema