TypeScript client

import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.workflowSchedules.batchWorkflowSchedules({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": {
        "message": "<string>",
        "code": "<string>"
      }
    }
  ],
  "outcome": {
    "totalCount": 123,
    "successCount": 123,
    "failureCount": 123,
    "appliedCount": 123,
    "noopCount": 123
  }
}

Workflow schedules

Batch workflow schedules

Delete, pause or resume up to 100 workflow schedules in one request. Delete uses ids; pause/resume use items with expectedRevision and expectedCampaignRevision for a campaign-owned schedule. State changes use bounded concurrency and independent revision-checked transactions, preserve campaign activation checks and plan only future occurrences. Permission edit_workflows is checked once. Every item returns applied, noop or failed in request order, with errors and outcome counts. Failed items remain unchanged. Canonical campaign schedules cannot be deleted here; delete the campaign instead.

POST

teams

{teamId}

workflow-schedules

batch

TypeScript client

import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.workflowSchedules.batchWorkflowSchedules({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": {
        "message": "<string>",
        "code": "<string>"
      }
    }
  ],
  "outcome": {
    "totalCount": 123,
    "successCount": 123,
    "failureCount": 123,
    "appliedCount": 123,
    "noopCount": 123
  }
}

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.

Body

application/json

Option 1
Option 2

action

enum<string>

required

The action applied to every listed id. delete removes each row exactly as the single delete endpoint does.

Available options:

delete

ids

string<uuid>[]

required

an array of at most 100 item(s)

Required array length: 1 - 100 elements

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

WorkspaceBatchResponse

data

object[]

required

One result per requested id, in request order.

Show child attributes

outcome

object

required

Show child attributes

List workflow schedule triggers