---
title: "Pause a schedule"
method: POST
path: "/api/schedules/{schedule_id}/pause"
tags: ["Schedules"]
---

# Pause a schedule

`POST /api/schedules/{schedule_id}/pause`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/schedules/{schedule_id}/pause`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `http://oauth2.{domain}.com/token` scopes: `sch`
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/schedules/:schedule_id/pause/post.ts> (a function with typed inputs; its response is checked against the schema)

Pause a recurring scheduled message, preventing Airship from sending messages on a recurring scheduled message interval. Use the `/resume` endpoint to resume a schedule. The pause operation cannot be completed for recurring schedules that have schedule end times in the past.

## Request body

- object

## Response `204`

An API request was successful, but there is no response body to return.

## Other responses

- `400`: Returned if the schedule end time for a recurring schedule is in the past.
- `401`: Authentication information (the app key and secret or bearer token) was either incorrect or missing.
- `403`: Authentication was correct, but the user does not have permission to access the requested API, e.g., if the feature in question is not included in your pricing plan.
- `404`: The requested resource doesn't exist.
- `500`: Occurs if a schedule fails to pause. The error includes a list of `failed_triggers`, detailing the schedule triggers that caused this operation to fail.

---

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