Schedules

Update schedules

Changed on

Updates one or more existing schedules with new timing, data, or other properties. All specified schedule IDs will be updated with the same values. This endpoint also handles inline identifications for the actor, recipient, and tenant fields.

put/v1/schedules

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/schedules
  • Auth: HTTP bearer

Request body

dataobject nullable

An optional map of data to pass into the workflow execution. There is a 10MB limit on the size of the full data payload. Any individual string value greater than 1024 bytes in length will be truncated in your logs.

ending_atstring date-time nullable

The ending date and time for the schedule.

schedule_idsstring[] required

A list of schedule IDs.

scheduled_atstring date-time nullable

The starting date and time for the schedule.

Example request

{
  "actor": null,
  "data": {
    "key": "value"
  },
  "ending_at": null,
  "repeats": [
    {
      "__typename": "ScheduleRepeat",
      "day_of_month": null,
      "days": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri",
        "sat",
        "sun"
      ],
      "frequency": "daily",
      "hours": null,
      "interval": 1,
      "minutes": null
    }
  ],
  "schedule_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "scheduled_at": null,
  "tenant": "acme_corp"
}

Response

OK

__typenamestring

The typename of the schema.

dataobject nullable

An optional map of data to pass into the workflow execution. There is a 10MB limit on the size of the full data payload. Any individual string value greater than 1024 bytes in length will be truncated in your logs.

idstring uuid required

Unique identifier for the schedule.

inserted_atstring date-time required

Timestamp when the resource was created.

last_occurrence_atstring date-time nullable

The last occurrence of the schedule.

next_occurrence_atstring date-time nullable

The next occurrence of the schedule.

tenantstring nullable

The tenant to trigger the workflow for. Triggering with a tenant will use any tenant-level overrides associated with the tenant object, and all messages produced from workflow runs will be tagged with the tenant.

updated_atstring date-time required

The timestamp when the resource was last updated.

workflowstring required

The workflow the schedule is applied to.

Example response

[
  {
    "__typename": "Schedule",
    "actor": null,
    "data": null,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inserted_at": "2021-01-01T00:00:00Z",
    "last_occurrence_at": null,
    "next_occurrence_at": null,
    "recipient": {
      "__typename": "User",
      "avatar": null,
      "created_at": null,
      "email": "jane@ingen.net",
      "id": "jane",
      "name": "Jane Doe",
      "phone_number": null,
      "timezone": null,
      "updated_at": "2024-05-22T12:00:00Z"
    },
    "repeats": [
      {
        "__typename": "ScheduleRepeat",
        "day_of_month": null,
        "days": [
          "mon",
          "tue",
          "wed",
          "thu",
          "fri",
          "sat",
          "sun"
        ],
        "frequency": "daily",
        "hours": null,
        "interval": 1,
        "minutes": null
      }
    ],
    "tenant": null,
    "updated_at": "2021-01-01T00:00:00Z",
    "workflow": "workflow_123"
  }
]

Changes

  • 6f88a4142e34Revision changes
    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

  • fcba175ebc76Revision changes
    • breaking

      the request property ////// became not nullable

    • breaking

      the request property ////// became not nullable

    • breaking

      the ////// request property type changed from boolean to no type

    • breaking

      the ////// request property type changed from boolean to no type

    • info

      added subschema #1 subschema #3 to the ////// request property anyOf list

    • info

      added subschema #1 subschema #3 to the ////// request property anyOf list