---
title: "Cancel Schedule"
method: POST
path: "/v1/schedules/{schedule_id}/cancel"
tags: ["Schedules"]
---

# Cancel Schedule

`POST /v1/schedules/{schedule_id}/cancel`

## Request

- Base URL: `https://api.pinbridge.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pinbridge.io/v1/schedules/{schedule_id}/cancel`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Cancel a scheduled pin.

## Path parameters

- `schedule_id` string, uuid, required

## Headers

- `x-api-key` string, nullable
- `authorization` string, nullable

## Response `200`

Successful Response

- ScheduleResponse: Response schema for a schedule.
  - `id` string, uuid, required
  - `workspace_id` string, uuid, required
  - `pinterest_account_id` string, uuid, required
  - `run_at` string, date-time, required
  - `status` 'scheduled' | 'queued' | 'deferred' | 'running' | 'done' | 'failed' | 'canceled', required: Schedule status enum.
  - `payload` object, required
  - `last_error` string, nullable
  - `pin_id` string, uuid, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `warnings` ScheduleWarning[]: Set when creating or rescheduling: quota_may_be_exceeded means the schedule's month already has as many pins published or scheduled as the plan includes, so this pin may not publish.
    - `code` string, required: Stable warning code, e.g. quota_may_be_exceeded
    - `message` string, required
    - `remediation` string, nullable
    - `limit_type` string, nullable
    - `plan` string, nullable
    - `plan_name` string, nullable
    - `limit` integer, nullable
    - `used` integer, nullable: Pins already published or scheduled in the schedule's month
    - `recommended_plan` string, nullable
    - `recommended_plan_name` string, nullable
    - `recommended_limit` integer, nullable
    - `upgrade_url` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/pinbridge/apis/pinbridge-api.md) · [All operations](https://skmtc.dev/pinbridge/apis/pinbridge-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pinbridge/apis/pinbridge-api/revisions/b17603589d01?raw)