> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update schedule

> Change the fields of a schedule, or pause and resume it with the status, where an omitted field keeps its value; returns the updated schedule.

`updateSchedule(projectReference: String!, scheduleId: ID!, input: UpdateScheduleInput!): Schedule!`

Requires project.runs.write.

## Arguments

| Argument | Type | Required |
| - | - | - |
| `projectReference` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes |
| `scheduleId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes |
| `input` | [`UpdateScheduleInput!`](https://veryfront.com/docs/cloud/graphql/types/updatescheduleinput) | Yes |

## Input fields

### input

[`UpdateScheduleInput`](https://veryfront.com/docs/cloud/graphql/types/updatescheduleinput)

| Field | Type | Required |
| - | - | - |
| `name` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No |
| `target` | [`ScheduleTargetInput`](https://veryfront.com/docs/cloud/graphql/types/scheduletargetinput) | No |
| `schedule` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No |
| `timezone` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No |
| `status` | [`ScheduleUpdateStatus`](https://veryfront.com/docs/cloud/graphql/types/scheduleupdatestatus) | No |
| `runtimeTargetKind` | [`RuntimeTargetKind`](https://veryfront.com/docs/cloud/graphql/types/runtimetargetkind) | No |
| `runtimeTargetEnvironmentId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No |
| `runtimeTargetBranchId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No |
| `config` | [`JSON`](https://veryfront.com/docs/cloud/graphql/types/json) | No |
| `timeoutSeconds` | [`Int`](https://veryfront.com/docs/cloud/graphql/types/int) | No |
| `backoffLimit` | [`Int`](https://veryfront.com/docs/cloud/graphql/types/int) | No |
| `concurrencyPolicy` | [`ScheduleConcurrencyPolicy`](https://veryfront.com/docs/cloud/graphql/types/scheduleconcurrencypolicy) | No |
| `maxRuns` | [`Int`](https://veryfront.com/docs/cloud/graphql/types/int) | No |

## Response

Returns [`Schedule!`](https://veryfront.com/docs/cloud/graphql/types/schedule). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | |
| `projectId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | |
| `name` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `status` | [`ScheduleStatus!`](https://veryfront.com/docs/cloud/graphql/types/schedulestatus) | |
| `target` | [`ScheduleTarget!`](https://veryfront.com/docs/cloud/graphql/types/scheduletarget) | |
| `schedule` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | The cron expression. |
| `timezone` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `runtimeTargetKind` | [`RuntimeTargetKind!`](https://veryfront.com/docs/cloud/graphql/types/runtimetargetkind) | |

[All fields of `Schedule`](https://veryfront.com/docs/cloud/graphql/types/schedule).

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
mutation UpdateSchedule($projectReference: String!, $scheduleId: ID!, $input: UpdateScheduleInput!) {
  updateSchedule(projectReference: $projectReference, scheduleId: $scheduleId, input: $input) {
    id
    projectId
    name
    status
    createdAt
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "example-project",
  "scheduleId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "status": "paused"
  }
}
```

<details>
  <summary>Try this mutation</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Mutation

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.