CustomEntityTypes.update

PATCH

/entities/{custom_entity_type_api_name}/{id}

Modifies CustomEntityType or {custom_entity_type_api_name} with given id(s)

Request

Path Params

Query Params

Body Params application/jsonRequired

Example

{
    "form_edit": {},
    "is_readonly": false,
    "name": "string",
    "settings": "blob"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/entities//?validation-level' \
--header 'Content-Type: application/json' \
--data-raw '{
    "form_edit": {},
    "is_readonly": false,
    "name": "string",
    "settings": "blob"
}'

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting CustomEntityType

Body

Example

{
    "success": true,
    "data": {
        "has_draft": false,
        "is_delete_protected": false,
        "form_edit_api": {},
        "can_change_readonly": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "form_edit": {},
        "is_readonly": false,
        "name": "string",
        "settings": "blob",
        "is_published": false,
        "entity_api_name": "string"
    }
}

🟠404Not Found

🔴500Internal Server Error

Modified at 2025-10-29 12:50:57

CustomEntityTypes.delete

CustomEntityTypes.list