runSchedule

POST

/api/v1/schedules/{scheduleId}/run

Run now (operator).

runSchedule

curl --request POST \
  --url '<base-url>/api/v1/schedules/<scheduleId>/run' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/schedules/<scheduleId>/run';
const options = {
  method: 'POST',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/schedules/<scheduleId>/run"

headers = {"cookie": "agenthold_session=<agenthold_session>"}

response = requests.post(url, headers=headers)

print(response.text)

Response example

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

scheduleId
string
required

Returns

202

The turn started.

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required

409

Error.

JSON

error
string
required