Delete workflow schedule

TypeScript client

import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.workflowSchedules.deleteWorkflowSchedule({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  workflowScheduleId: process.env.OCTOSPARK_WORKFLOW_SCHEDULE_ID ?? "workflowScheduleId",
})

{
  "deleted": true
}

DELETE

teams

{teamId}

workflow-schedules

{workflowScheduleId}

TypeScript client

import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.workflowSchedules.deleteWorkflowSchedule({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  workflowScheduleId: process.env.OCTOSPARK_WORKFLOW_SCHEDULE_ID ?? "workflowScheduleId",
})

{
  "deleted": true
}

Authorizations

Authorization

string

header

required

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

Path Parameters

teamId

string

required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

workflowScheduleId

string

required

Workflow schedule id (UUID), as returned by the list/create workflow-schedules endpoints.

Response

Success

deleted

boolean

required

Workflow schedule Update workflow schedule