CIcircleci
Schedule

Delete a schedule

Deletes a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.

delete/schedule/{schedule-id}

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/schedule/{schedule-id}
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

schedule-idstring uuid required

The unique ID of the schedule.

Response

A confirmation message.

messagestring required

A human-readable message

Changes

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