Rename an entity sandbox

PATCH

/entity-sandboxes/{id}

Updates the display name (name) of an existing shadow entity sandbox. This is a pure metadata edit against the entity-sandbox record — it never contacts the sandbox server, so it can be performed regardless of the sandbox's current activation_status (including while a sandbox is still provisioning) and regardless of whether the sandbox is the entity's is_default one.

The caller must have can_edit_entity (or wildcard *) ACL access to the live entity that the sandbox belongs to. The new name must be unique among sandboxes already created for that same entity; renaming to a name already in use by a sibling sandbox fails with a conflict.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The entity sandbox was renamed successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/entity-sandboxes/01JQAB1234567890ABCDEFGHIJ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "QA Regression"
}'

Response Example

200 - Success

{
    "message": "Entity sandbox renamed successfully",
    "status": "success",
    "data": {
        "id": "01JQAB1234567890ABCDEFGHIJ",
        "entity_id": "01JXYZ1234567890ABCDEFGHIJ",
        "name": "QA Regression",
        "is_default": false,
        "activation_status": "completed",
        "sandbox_entity_id": "sbx_ent_9f3c7a2b"
    }
}

Modified at 2026-09-30 00:29:45

Delete an entity sandbox

Passkeys