PATCH {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/schedules/{schedule_id}

Parameter	Type	Required	Description
TenantURL	String	Yes	The base URL for your tenant.
tenant_id	String	Yes	The unique identifier of your tenant.
schedule_id	String	Yes	The unique identifier of the schedule.

Header	Value	Required
Authorization	<access_token>	Yes
Content-Type	application/json	Yes

Parameter	Type	Required	Description	Accepted values / Default
name	String	No	The new display name for the schedule.	—
query	String	No	The new prompt or query to send to the agent.	—
agent_id	String	No	The unique identifier of the new agent to run.	—
cron_expression	String	No	The new cron expression, in the format minute hour day-of-month month day-of-week.	—
interval_minutes	Integer	No	The new interval in minutes between runs.	—
status	String	No	The new status. Use active to resume the schedule, paused to stop it without deleting it, or cancelled to delete it.	—

PATCH {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/schedules/example-id
Authorization: <access_token>
Content-Type: application/json

{
  "name": "Updated escalation check",
  "query": "Check high-priority support tickets",
  "agent_id": "improved-support-agent",
  "cron_expression": "0 10 * * MON-FRI",
  "interval_minutes": 120,
  "status": "paused"
}

Parameter	Type	Description
schedule_id	String	The unique identifier of the schedule.
tenant_id	String	The unique identifier of the tenant.
agent_id	String	The unique identifier of the agent that the job or schedule runs.
name	String	The display name.
query	String	The prompt or query sent to the agent on each run.
schedule_type	String	The type of schedule: recurring or run-once.
cron_expression	String	The cron expression for the schedule, when schedule_type is recurring.
interval_minutes	Integer	The interval in minutes between runs, when schedule_type is recurring.
status	String	The status of the schedule: active, paused, running, cancelled, completed, or failed.
next_run_at	String	The date and time of the next scheduled run.
last_run_at	String	The date and time of the last run.
run_count	Integer	The number of times this schedule has run.
run_once	Boolean	Whether this is a one-time (run-once) schedule.
last_conversation_id	String	The unique identifier of the conversation from the most recent run.
created_by	String	The unique identifier of the user who created the schedule.
created_at	String	The date and time when the job or schedule was created.
updated_at	String	The date and time when the record was last updated.

{
  "schedule_id": "sched-abc123",
  "tenant_id": "tenant-xyz",
  "agent_id": "my-support-agent",
  "name": "Daily support escalation check",
  "query": "Check for support tickets requiring escalation",
  "schedule_type": "recurring",
  "cron_expression": "0 9 * * MON-FRI",
  "interval_minutes": 60,
  "status": "active",
  "next_run_at": "2025-05-14T09:00:00Z",
  "last_run_at": "2025-05-13T09:00:00Z",
  "run_count": 5,
  "run_once": false,
  "last_conversation_id": "conv-abc123",
  "created_by": "user@example.com",
  "created_at": "2025-05-01T10:00:00Z",
  "updated_at": "2025-05-13T15:30:00Z"
}

HTTP status	Description	Recommended action
422 Unprocessable Entity	Validation Error	Review the request parameters or body, correct the invalid values, and resend the request.