Restore

Restores a previously deleted object for the specified content type. The object is identified by its id in the route.

The endpoint does not accept a request body. A successful request returns a JSON response confirming that the object was restored.

Endpoint

POST /{contentType}/{id}/restore

Replace {contentType} with route of the content type you want to restore an object for, and {id} with the identifier of the object to restore.

Example:

POST /products/1/restore

The available content types depend on the API configuration.

Path Parameters

Parameter	Type	Required	Description
`contentType`	string	Yes	The route of the content type the object belongs to.
`id`	integer	Yes	The unique identifier of the object to restore.

Request Body

None. This endpoint does not accept a request body.

Response

A successful request returns a JSON response confirming that the object was restored.

Content-Type: application/json

Example Response

{
    "success": true
}

The response indicates only whether the restoration succeeded. It does not return the restored object. To retrieve the full object, including its system fields, use the View endpoint.

Response Fields

Top-Level Fields

Field	Type	Description
`success`	boolean	Indicates whether the object was restored successfully. `true` when the restoration succeeded.

Complete Example

The following example restores the object with ID 1.

Request

curl -X POST "https://api.example.com/{contentType}/{id}/restore" \
    -H "Authorization: Bearer YOUR_TOKEN"

Replace the following placeholders before sending the request:

{contentType} — The content type to restore an object for, such as products, if supported by the API.
{id} — The identifier of the object to restore, such as 1.
YOUR_TOKEN — A valid bearer authentication token.

Response

{
    "success": true
}

Notes

Content type and ID determine the endpoint. Replace {contentType} with the content type and {id} with the identifier of the object you want to restore.
Only deleted objects can be restored. This endpoint is intended for objects that were previously removed using the Delete endpoint.
No request body is required. The object is identified by the route alone.
Only a success status is returned. The response contains a success value, not the restored object.
Response uses JSON. The response uses the application/json content type.