Skip to main content

Create a scheduled job

POST 
/api/v1/scheduler/create-job

Creates a new scheduled job. The job becomes active immediately and fires on its next matching time.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Run work on a schedule · Manage jobs · Automate recurring agent work · Create a scheduled job · Monitor executions and retries · Schedule retries and auto-pause

Request​

Responses​

Scheduled job created

Schedule a weekday digest while acting on behalf of its owner; replace the target URL with your endpoint.​

Section ID: DOC-CP-scheduling-api-createJob#example-scheduled-jobs-createJob-request

Request example

{
  "name": "Daily digest",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * 1-5",
  "timezone": "America/New_York",
  "target": {
    "url": "https://your-api.example.com/jobs/daily-digest",
    "kind": "digest",
    "payload": {
      "report": "daily"
    }
  }
}

Guide request for Step 4: Create the schedule. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-build-scheduled-agents-02-request

Request example

{
  "name": "Daily agent briefing",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * 1-5",
  "timezone": "America/New_York",
  "target": {
    "url": "https://api.example.com/hooks/scheduled-agent",
    "kind": "agent-briefing",
    "payload": {
      "task": "daily-briefing"
    }
  }
}

Guide request for Variant: remind the user once at a chosen time. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-creating-02-request

Request example

{
  "name": "Send welcome email",
  "scheduleType": "SCHEDULE_TYPE_ONCE",
  "scheduledAt": "2026-10-10T14:00:00Z",
  "target": {
    "url": "https://your-api.example.com/jobs/welcome",
    "kind": "notification",
    "payload": {
      "user_id": "usr_abc123"
    }
  }
}

Guide request for Variant: refresh application data every few minutes. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-creating-03-request

Request example

{
  "name": "Sync cache",
  "scheduleType": "SCHEDULE_TYPE_RECURRING_INTERVAL",
  "intervalSeconds": 300,
  "target": {
    "url": "https://your-api.example.com/jobs/cache-sync",
    "kind": "maintenance"
  }
}

Guide request for Recover a temporary receiver failure. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-execution-02-request

Request example

{
  "name": "Critical alert",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "*/5 * * * *",
  "target": {
    "url": "https://your-api.example.com/jobs/alert",
    "kind": "alert"
  },
  "retryPolicy": {
    "maxAttempts": 3,
    "initialBackoffMs": 1000,
    "maxBackoffMs": 10000
  }
}

Guide request for Variant: use your application’s reminder identifier. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-managing-08-request

Request example

{
  "name": "Daily digest",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * 1-5",
  "externalId": "user-42-daily-digest",
  "target": {
    "url": "https://your-api.example.com/jobs/daily-digest",
    "kind": "digest"
  }
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-scheduling-api-createJob#example-scheduled-jobs-createJob-response

Response example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "tenantId": "example_123",
  "projectId": "example_123",
  "ownerSubject": "example",
  "name": "example",
  "description": "example",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * *",
  "timezone": "example",
  "scheduledAt": "2026-09-16T12:00:00Z",
  "intervalSeconds": 1,
  "target": {
    "url": "https://example.com/callback",
    "method": "example",
    "kind": "example",
    "payload": {
      "example": "value"
    }
  },
  "state": "SCHEDULE_STATUS_ACTIVE",
  "retryPolicy": {
    "maxAttempts": 1,
    "initialBackoffMs": 1,
    "maxBackoffMs": 1
  },
  "metadata": {
    "example": "value"
  },
  "autoPauseThreshold": 1,
  "externalId": "example_123",
  "createdAt": "2026-09-16T12:00:00Z",
  "createdBySubject": "example",
  "updatedAt": "2026-09-16T12:00:00Z",
  "updatedBySubject": "example",
  "pausedAt": "2026-09-16T12:00:00Z",
  "pausedBySubject": "example",
  "pausedReason": "example",
  "resumedAt": "2026-09-16T12:00:00Z",
  "resumedBySubject": "example",
  "deletedAt": "2026-09-16T12:00:00Z",
  "deletedBySubject": "example",
  "lastTriggeredAt": "2026-09-16T12:00:00Z",
  "nextTriggerAt": "2026-09-16T12:00:00Z",
  "triggerCount": "1",
  "failureCount": "1",
  "consecutiveFailureCount": "1"
}

Illustrative response for Step 4: Create the schedule. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-build-scheduled-agents-json-03-response

Response example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "name": "Daily agent briefing",
  "state": "SCHEDULE_STATUS_ACTIVE",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * 1-5",
  "timezone": "America/New_York",
  "nextTriggerAt": "2026-06-04T13:00:00Z",
  "createdAt": "2026-06-03T14:00:00Z"
}

Illustrative response for Confirm and save the next scheduled time. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-createJob#example-cookbook-core-platform-scheduling-creating-json-01-response

Response example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "name": "Daily digest",
  "state": "SCHEDULE_STATUS_ACTIVE",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * 1-5",
  "timezone": "America/New_York",
  "nextTriggerAt": "2026-06-04T13:00:00Z",
  "createdAt": "2026-06-03T14:00:00Z"
}

Document ID: DOC-CP-scheduling-api-createJob. Section identities and revisions.

SectionStable reference
Create a scheduled jobDOC-CP-scheduling-api-createJob#overview
RequestDOC-CP-scheduling-api-createJob#request
ResponsesDOC-CP-scheduling-api-createJob#responses