Skip to main content
POST
/
api
/
schedule
/
schedules.delete
Delete schedules
curl --request POST \
  --url https://api.example.com/api/schedule/schedules.delete \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "872815618512410358"
  ],
  "options": {
    "group_action": "single",
    "allow_partial": true
  }
}
'
{
  "deleted_count": 123,
  "deleted": {},
  "failed_count": 123,
  "failed": {}
}

Body

application/json
​
ids
string<snowflake>[]
required
​
options
object
required

Response

Schedule(s) deleted. When options.allow_partial is true, some schedules might not be deleted due to lock dates or permissions.

Result of deleting schedule(s).

​
deleted_count
integer
required
​
deleted
object
required
​
failed_count
integer
required
​
failed
object
required