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

# Update schedule

<ParamField path="id" type="integer" required>
  Pipeline schedule ID
</ParamField>

<b>Body</b>

<br />

<br />

<ParamField body="pipeline_schedule" type="object" required>
  <Expandable title="payload" defaultOpen="true">
    <ParamField body="event_matchers" type="array of objects">
      Deprecated. Used only for maintaining existing legacy event triggers.
    </ParamField>

    <ParamField body="name" type="string">
      Trigger names are trimmed before validation. The name must include at least one letter or
      number, cannot exceed 255 characters, and must be unique within the pipeline.
    </ParamField>

    <ParamField body="schedule_interval" type="string">
      Required when `schedule_type` is `time`.
    </ParamField>

    <ParamField body="schedule_type" type="string">
      Trigger type. Use `api` or `time` for supported non-legacy triggers. `event` is deprecated
      and only used for existing legacy event triggers.
    </ParamField>

    <ParamField body="settings" type="object">
      Additional settings for the trigger.

      <Expandable title="properties">
        <ParamField body="timeout" type="integer">
          Optional run timeout in seconds. When provided, the value must be a positive integer.
          Use `null` or omit this field for no timeout.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="sla" type="integer">
      Optional SLA threshold in seconds. When provided, the value must be a positive integer.
      Use `0` or `null` to clear an existing SLA, or omit this field for no SLA change.
    </ParamField>

    <ParamField body="start_time" type="datetime">
      Persisted schedule start timestamp. For `@once`, this value determines the single run time;
      for recurring time schedules, it anchors when the schedule begins.
    </ParamField>

    <ParamField body="status" type="string" />

    <ParamField body="tags" type="array of strings">
      Non-empty tag names to associate with the trigger. Tag names are trimmed and duplicate names
      are ignored before persistence. Each tag name cannot exceed 70 characters.
    </ParamField>

    <ParamField body="variables" type="object" />
  </Expandable>
</ParamField>

<CodeGroup>
  ```curl cURL theme={"system"}
  curl --request PUT \
    --url 'http://localhost:6789/api/pipeline_schedules/55?api_key=zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
    --header 'OAUTH-TOKEN=some_really_long_string' \
    --data '{
      "pipeline_schedule": {
        "name": "black voice11111",
        "schedule_type": "time",
        "schedule_interval": "@once",
        "start_time": "2023-03-06 04:53:00",
        "variables": {
          "env": "dev112222",
          "test": 11111
        },
        "sla": 1000,
        "settings": {
          "allow_blocks_to_fail": true,
          "create_initial_pipeline_run": false,
          "skip_if_previous_running": true,
          "timeout": 3600
        }
      }
    }'
  ```
</CodeGroup>

```json theme={"system"}
{
  "pipeline_schedule": {
    "id": 55,
    "created_at": "2023-03-08 04:52:54.268096+00:00",
    "updated_at": "2023-04-01 00:52:11.753497+00:00",
    "name": "black voice11111",
    "pipeline_uuid": "example_pipeline",
    "schedule_type": "time",
    "start_time": "2023-03-06 04:53:00+00:00",
    "schedule_interval": "@once",
    "status": "inactive",
    "variables": {
      "env": "dev112222",
      "test": 11111
    },
    "sla": 1000,
    "token": "67d62ed3e66143839f58945bb7d16387",
    "settings": {
      "allow_blocks_to_fail": true,
      "create_initial_pipeline_run": false,
      "skip_if_previous_running": true,
      "timeout": 3600
    },
    "event_matchers": []
  }
}
```


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