Pause a schedule

Transitions a schedule to STATE_PAUSED. Paused schedules retain history but do not fire.

post/v1/workspaces/{workspaceId}/agents/{agentId}/schedules/{id}:pause

Path parameters

workspaceIdstring required

Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

agentIdstring required

Example:agent_01HXKD2E5NQM3T9AYWCFMGWT9Y

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

idstring required

Example:as_01HXKD2E5NQM3T9AYWCFMZZZBD

Schedule ID. Accepts the canonical as_… form or the external_id:<value> form.

Request body

workspaceIdstring

Workspace ID.

agentIdstring

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

idstring

Schedule ID. Accepts the canonical as_… form or the external_id:<value> form.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "agentId": "agent_01HXKD2E5NQM3T9AYWCFMGWT9Y",
  "id": "as_01HXKD2E5NQM3T9AYWCFMZZZBD"
}

Response

state'STATE_UNSPECIFIED' | 'STATE_ACTIVE' | 'STATE_PAUSED' | 'STATE_ARCHIVED' enum required

The current lifecycle state of the schedule. Output only. Schedules are created STATE_ACTIVE; use the :pause, :resume, and :archive actions to transition between states.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "spec": {
    "variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP"
  },
  "info": {
    "lastObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}

Changes

Changed in 4 of the 57 revisions of this API.146

Jul 4, 202609ccecfe3ece33See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jul 2, 202606e0e37c149911See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 10, 2026d2d65c2665bd11See the full diff
- ▲
  the response property / became optional for the status
  response-property-became-optional
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Jun 9, 202613d98d37dd961See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history