---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Resume a schedule"
description: "`workflows.schedules.resume` (POST /v1/{name}:resume): Resumes a paused Schedule; missed fires follow `catchup_window`."
type: reference
product: jobs
summary: "Resumes a paused Schedule; missed fires follow `catchup_window`."
updated: 2026-09-28
nav: false
---

Resumes a paused Schedule; missed fires follow `catchup_window`.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule:resume`
- **Scope** `workflows:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [schedules](/docs/api/schedules)
- **Validate-only** `validate_only=true` runs every check and writes nothing
- **Operation** answers with an `Operation`; the result is `Schedule`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the schedule. Required. |
| `etag` | `string` | Act only if the current etag matches. |
| `validate_only` | `bool` | Validate without writing anything. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `{parent-of-target}/operations/{operation}`. |
| `target` | `string` | The name of the Resource being changed. |
| `target_generation` | `int64` | The generation this Operation waits for. |
| `verb` | `OperationVerb` | What the Operation does. One of `create`, `update`, `delete`, `custom`. |
| `custom_verb` | `string` | The custom method verb when `verb` is CUSTOM, for example `revoke`. |
| `done` | `bool` | Whether the Operation has finished. |
| `create_time` | `timestamp` | When the Operation started. |
| `end_time` | `timestamp` | When the Operation finished. |
| `response` | `any` | The settled Resource (or Empty for a delete). One of the `result` group. |
| `error` | `ProblemDetails` | The failure, as the one error body. One of the `result` group. |
| `progress` | `OperationProgress` | Progress while not `done`. |

### ProblemDetails

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | `https://sylphx.com/docs/errors/<code in kebab-case>`. |
| `title` | `string` | A short customer-safe summary of the problem class. |
| `status` | `int32` | The HTTP status, fixed by `grpc_status`. |
| `detail` | `string` | A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data. |
| `instance` | `string` | The request id (`Sylphx-Request-Id`). |
| `code` | `string` | The stable UPPER_SNAKE code, one of ErrorCode without its prefix. |
| `grpc_status` | `string` | One of the 16 canonical gRPC status names, for example `ABORTED`. |
| `retryable` | `bool` | Whether the same request may be retried. |
| `effect` | `ErrorEffect` | What the failed call committed. One of `none`, `applied`, `unknown`. |
| `retry_after_ms` | `int64` | How long to wait before retrying, when the server knows. |
| `details` | `any[]` | Typed details such as PreconditionFailure or EntitlementDenial. |

### OperationProgress

| Field | Type | What it is |
| --- | --- | --- |
| `percent` | `int32` | Percent complete, when the controller can tell. |
| `message` | `string` | A customer-safe progress message. |
| `conditions` | `Condition[]` | The target's conditions when this progress was read. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule:resume" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const operation = await sylphx.workflows.schedules.resume({ name: 'orgs/acme/projects/shop/envs/production/schedules/schedule' })
```

**Rust**

```rust
let mut req = sylphx::workflows::ResumeScheduleRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/schedules/schedule".to_string();
let operation = sx.workflows().schedules().resume(req).await?;
```

**CLI**

```bash
sylphx workflows schedules resume orgs/acme/projects/shop/envs/production/schedules/schedule
```

**MCP**

```json
{ "method_id": "workflows.schedules.resume", "args": {"name":"orgs/acme/projects/shop/envs/production/schedules/schedule"} }
```