Skip to main content
DELETE
Archive or cancel a pricing version

Authorizations

Authorization
string
header
required

An access token from Barndoor's identity provider, sent as Authorization: Bearer <token>. Use a service-account token from the OAuth 2.0 client-credentials grant for scripts and CI, or a signed-in user's token. The caller needs the admin role in the organization. Gateway API keys (bd-...) are not accepted here.

Path Parameters

id
string<uuid>
required

Record ID (UUID)

Response

Deletion acknowledgement

What the archive request did.

archived
boolean
required

Whether the current version was archived.

cancelled_scheduled
integer<int64>
required

How many scheduled future versions were cancelled.

deleted
boolean
required

Always true.

mode
string
required

Which action was taken: archiving the rule, or cancelling a scheduled version.