Objects

Delete an Object

Delete an Object from the Bucket. This is destructive and not reversible through the API: confirm with the user before calling it.

delete/buckets/{slug}/objects/{object_id}

Request

Base URL
https://api.cosmicjs.com/v3
Auth
HTTP bearer
TypeScript
https://skmtc.dev/cosmicjs/apis/cosmic-rest-api-v3/docs/buckets/:slug/objects/:object_id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

trigger_webhookboolean

Set to true to fire the corresponding webhook for this action.

Response

The Object was deleted.

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.