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

# Cancel Schedule

`POST /api/v1/push-schedules/{schedule_id}/cancel`

## Path parameters

- `schedule_id` string, uuid, required

## Headers

- `authorization` string, nullable — Bearer <token>

## Response `200`

Successful Response

- EnvelopeScheduleResponse
  - `data` ScheduleResponse, required
    - `id` string, uuid, required
    - `customer_id` string, uuid, required
    - `customer_name` string, nullable
    - `draft_id` string, uuid, required
    - `status` string, required
    - `subject` string, nullable, required
    - `body` string, required
    - `deep_link` string, nullable, required
    - `scheduled_at` string, date-time, required
    - `expires_at` string, date-time, required
    - `created_at` string, date-time, required
    - `completed_at` string, date-time, nullable, required
    - `reason` string, nullable, required
    - `override_hold` boolean, required
    - `approval` object, required
    - `outreach_id` string, uuid, nullable, required
    - `tracking_token` string, nullable, required
    - `push_outcome` object, nullable
  - `meta` Meta
    - `request_id` string
    - `timestamp` string, date-time
    - `total` integer, nullable
    - `truncated` boolean, nullable
    - `reply_total` integer, nullable
    - `metric_total` integer, nullable
    - `people_total` integer, nullable
    - `coverage` object, nullable
    - `event_scope` string, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-20** `299da1f7604a` — 2 info
  - added the optional property `meta/coverage` to the response with the `200` status
  - added the optional property `meta/event_scope` to the response with the `200` status
- **2026-09-18** `ef5d9b948f55` — 1 info
  - added the required property `data/deep_link` to the response with the `200` status
- **2026-09-17** `2eae594b5490` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/minro/apis/minro-cs-platform/changes/api/v1/push-schedules/:schedule_id/cancel/post.md)

---

[API](https://skmtc.dev/minro/apis/minro-cs-platform.md) · [All operations](https://skmtc.dev/minro/apis/minro-cs-platform/llms.txt) · [OpenAPI document](https://skmtc.dev/minro/apis/minro-cs-platform/revisions/e309d6571e7b?raw)