Delete
Deletes an existing 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 deleted.
Endpoint
Replace {contentType} with route of the content type you want to delete an
object from, and {id} with the identifier of the object to delete.
Example:
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 delete. |
Request Body
None. This endpoint does not accept a request body.
Response
A successful request returns a JSON response confirming that the object was deleted.
Content-Type: application/json
Example Response
The response indicates only whether the deletion succeeded. It does not return the deleted object.
Response Fields
Top-Level Fields
| Field | Type | Description |
|---|---|---|
success |
boolean | Indicates whether the object was deleted successfully, true when the deletion succeeded. |
Complete Example
The following example deletes the object with ID 1.
Request
Replace the following placeholders before sending the request:
{contentType}— The content type to delete an object from, such asproducts, if supported by the API.{id}— The identifier of the object to delete, such as1.YOUR_TOKEN— A valid bearer authentication token.
Response
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 delete. - No request body is required. The object is identified by the route alone.
- Only a success status is returned. The response contains a
successvalue, not the deleted object. - Response uses JSON. The response uses the
application/jsoncontent type.