Skip to main content

ScheduleEnvelope

okbooleanrequired

Possible values: [true]

request_idstringrequired
Example: req_01HXYZABC123
data objectrequired
schedule objectrequired
idstringrequired
jobstringrequired
job_idstringnullable
website_idstringnullable
website_urlstringnullable
cronstringrequired
enabledbooleanrequired
createdstring[]required
runs_countintegernullable

Possible values: >= 0

created_jobs object[]
  • Array [
    • idstringrequired
    statusJobStatusrequired

    Possible values: [pending, processing, completed, failed]

    typesstring[]required
    website_idstringnullable
    website_urlstringnullable
    created_atdate-timenullable
  • ]
    • created_atdate-timenullable
    updated_atdate-timenullable
    property name*any
    ScheduleEnvelope
    {
      "ok": true,
      "request_id": "req_01HXYZABC123",
      "data": {
        "schedule": {
          "id": "string",
          "job": "string",
          "job_id": "string",
          "website_id": "string",
          "website_url": "string",
          "cron": "string",
          "enabled": true,
          "created": [
            "string"
          ],
          "runs_count": 0,
          "created_jobs": [
            {
              "id": "string",
              "status": "pending",
              "types": [
                "string"
              ],
              "website_id": "string",
              "website_url": "string",
              "created_at": "2024-07-29T15:51:28.071Z"
            }
          ],
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z"
        }
      }
    }