Skip to main content
DELETE
JavaScript
Permanently remove a schedule from an agent.
Delete works in any state, active, paused, or archived, so you do not have to pause or archive first. It removes the schedule’s definition and stops any future fires. Objectives it already created are their own resources and are untouched, find them by filtering the objective list on agentScheduleId. Delete when you want the schedule gone. Reach for archive instead when you want to stop it but keep the record.

Archive a schedule

Retire it but keep the record.

List schedules

See what remains on the agent.

List objectives

The runs a deleted schedule left behind.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

agentId
string
required

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

Example:

"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y"

id
string
required

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

Example:

"as_01HXKD2E5NQM3T9AYWCFMZZZBD"

Response