Skip to main content
POST
Delete Pillars

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json
website_id
string<uuid>
required

The website whose pillars to delete.

pillar_ids
string<uuid>[]
required

Pillars to delete. A single delete is a one-element array.

Required array length: 1 - 20 elements

Response

Deletion report

success
enum<boolean>
required
Available options:
true
deleted_pillars
object[]
required

Pillars actually deleted. A deleted pillar cannot be re-fetched, so this is the caller's record of what was destroyed.

not_found_ids
string[]
required

Requested ids with no pillar on this website: already deleted or never existed.

failed_ids
string[]
required

Pillars whose delete errored. Each pillar deletes in its own transaction, so these are untouched and safe to retry.