updateSchedule

PUT

/api/v1/schedules/{scheduleId}

updateSchedule

curl --request PUT \
  --url '<base-url>/api/v1/schedules/<scheduleId>' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "name": "string",
  "cron": "string",
  "timezone": "string",
  "prompt": "string",
  "enabled": true
}
'

const url = '<base-url>/api/v1/schedules/<scheduleId>';
const options = {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({
    name: 'string',
    cron: 'string',
    timezone: 'string',
    prompt: 'string',
    enabled: true
  })
};

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>"

payload = {
    "name": "string",
    "cron": "string",
    "timezone": "string",
    "prompt": "string",
    "enabled": True
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "name": "string",
  "cron": "string",
  "timezone": "string",
  "prompt": "string",
  "enabled": true,
  "id": "string",
  "agentId": "string",
  "sessionId": "string",
  "createdBy": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string"
  },
  "nextRunAt": "2019-08-24T14:15:22Z",
  "lastRunAt": "2019-08-24T14:15:22Z",
  "lastError": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "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

Request body JSON required

name
string
required
maxLength: 100 · minLength: 1
cron
string
required
Five fields (minute hour day month weekday) or @hourly, @daily, @weekly.
prompt
string
required
minLength: 1
timezone
optional
string
IANA time zone. Default UTC.
enabled
optional
boolean

Returns

200

Updated.

JSON

name
string
required
maxLength: 100 · minLength: 1
cron
string
required
Five fields (minute hour day month weekday) or @hourly, @daily, @weekly.
timezone
string
required
IANA time zone. Default UTC.
prompt
string
required
minLength: 1
enabled
boolean
required
id
string
required
agentId
string
required
sessionId
string
required
createdBy
object
required
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}
nextRunAt
string
required
format: date-time
lastError
string
required
createdAt
string
required
format: date-time
lastRunAt
optional
string
format: date-time

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required