Skip to main content
POST
schedule.delete

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
scheduleId
string
required

The schedule's id, from schedule.create.

Pattern: ^sch_[0-9A-HJKMNP-TV-Z]{26}$

Response

The result

scheduleId
string
required

The deleted schedule's id.

deleted
boolean
required

Always true.