Sign in

v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-22116135580.0 KB
Objects
Bulk operations

Create schedules in bulk

Bulk creates up to 1,000 schedules at a time. This endpoint also handles inline identifications for the actor, recipient, and tenant fields.

post/v1/schedules/bulk/create

Request body

Example request

{
  "schedules": [
    {
      "data": {
        "key": "value"
      },
      "ending_at": null,
      "recipient": "dnedry",
      "repeats": [
        {
          "__typename": "ScheduleRepeat",
          "day_of_month": null,
          "days": [
            "mon",
            "tue",
            "wed",
            "thu",
            "fri",
            "sat",
            "sun"
          ],
          "frequency": "daily",
          "hours": null,
          "interval": 1,
          "minutes": null
        }
      ],
      "scheduled_at": null,
      "tenant": "acme_corp",
      "workflow": "comment-created"
    },
    {
      "data": {
        "key": "value"
      },
      "ending_at": null,
      "recipient": "esattler",
      "repeats": [
        {
          "__typename": "ScheduleRepeat",
          "day_of_month": null,
          "days": [
            "mon",
            "tue",
            "wed",
            "thu",
            "fri",
            "sat",
            "sun"
          ],
          "frequency": "daily",
          "hours": null,
          "interval": 1,
          "minutes": null
        }
      ],
      "scheduled_at": null,
      "tenant": "acme_corp",
      "workflow": "comment-created"
    }
  ]
}

Response

OK

__typenamestring required

The typename of the schema.

completed_atstring date-time nullable

Timestamp when the bulk operation was completed.

error_countinteger

The number of failed operations.

estimated_total_rowsinteger required

The estimated total number of rows to process.

failed_atstring date-time nullable

Timestamp when the bulk operation failed.

idstring uuid required

Unique identifier for the bulk operation.

inserted_atstring date-time required

Timestamp when the resource was created.

namestring required

The name of the bulk operation.

processed_rowsinteger required

The number of rows processed so far.

progress_pathstring uri

The URI to the bulk operation's progress.

started_atstring date-time nullable

Timestamp when the bulk operation was started.

status'queued' | 'processing' | 'completed' | 'failed' required

The status of the bulk operation.

success_countinteger required

The number of successful operations.

updated_atstring date-time required

The timestamp when the resource was last updated.

Example response

{
  "__typename": "BulkOperation",
  "completed_at": null,
  "error_count": 0,
  "error_items": [],
  "estimated_total_rows": 1000,
  "failed_at": null,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inserted_at": "2024-05-22T12:00:00Z",
  "name": "Bulk operation name",
  "processed_rows": 0,
  "progress_path": "https://api.switchboard.com/v1/bulk_operations/123e4567-e89b-12d3-a456-426614174000",
  "started_at": null,
  "status": "processing",
  "success_count": 0,
  "updated_at": "2024-05-22T12:00:00Z"
}