Update entity

PATCH

/page/{entityPath}/{entityId}

Updates an existing entity using the form page configuration. Supports partial updates
with custom field data validation. The entity can also be locked/unlocked for editing.

Custom Field Format: Use {fieldId}_{fieldName} as the key for custom field values.

Meta Object: If provided, the meta object is spread into the main request body for validation.

Locking: Use the isLocked field to control edit access to the entity.

Asset-Specific Updates: For asset entities, automatic updates trigger store features and campaign regeneration.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Entity updated successfully

Body

🟠400Bad Request

🟠404Not Found

🟠405Method Not Allowed

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Update asset with custom fieldsUpdate opportunity with meta objectLock entity for editing

curl --location -g --request PATCH 'https://prod.your-api-server.com/page/asset/?groups[]=82bf5510-5295-11f0-b0ba-adfe69a423b8&groups[]=93cg6620-5295-11f0-b0ba-adfe69a423b8' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Q1 Display Asset",
    "description": "Updated description for Q1 campaign",
    "91ce6620-5295-11f0-b0ba-adfe69a423b8_assetName": "Updated Custom Display Name",
    "a2df7730-5295-11f0-b0ba-adfe69a423b8_priority": "medium",
    "isLocked": false
}'

Response Example

200 - Successfully updated asset

{
    "_id": "e6fb1b70-5295-11f0-b0ba-adfe69a423b8",
    "name": "Updated Q1 Display Asset",
    "code": "Q1_DISPLAY_001",
    "description": "Updated description for Q1 campaign",
    "isLocked": false,
    "isActive": true,
    "meta": {
        "91ce6620-5295-11f0-b0ba-adfe69a423b8_assetName": "Updated Custom Display Name",
        "a2df7730-5295-11f0-b0ba-adfe69a423b8_priority": "medium",
        "b3e08840-5295-11f0-b0ba-adfe69a423b8_releaseDate": "2024-03-15"
    },
    "elementsQty": [],
    "features": [],
    "createdAt": "2024-03-15T10:30:00.000Z",
    "updatedAt": "2024-03-15T11:45:00.000Z",
    "__v": 0
}

Modified at 2025-09-25 10:04:16

Create new entity

Get single entity