Skip to main content
PATCH
/
projects
/
{project_reference}
/
schedules
/
{schedule_id}
Update Project Schedule
curl --request PATCH \
  --url https://api.veryfront.com/projects/{project_reference}/schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "schedule": "<string>",
  "timezone": "<string>",
  "runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "config": {},
  "timeout_seconds": 1,
  "backoff_limit": 1
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "target": {
    "id": "<string>",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "schedule": "<string>",
  "timezone": "<string>",
  "runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "config": {},
  "timeout_seconds": 123,
  "backoff_limit": 123,
  "concurrency_policy": "<string>",
  "last_scheduled_at": "<string>",
  "last_successful_at": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_as_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

​
project_reference
string
required
Minimum string length: 1
​
schedule_id
string<uuid>
required

Body

application/json
​
name
string
Required string length: 1 - 255
​
target
object
​
schedule
string
Required string length: 1 - 255
​
timezone
string
Required string length: 1 - 128
​
runtime_target_kind
enum<string>
Available options:
main_branch,
environment,
preview_branch
​
runtime_target_environment_id
string<uuid> | null
​
runtime_target_branch_id
string<uuid> | null
​
config
object
​
timeout_seconds
integer
Required range: x > 0
​
backoff_limit
integer
Required range: x >= 0
​
concurrency_policy
enum<string>
Available options:
Allow,
Forbid,
Replace
​
status
enum<string>
Available options:
active,
paused

Response

Updated schedule

​
id
string<uuid>
required
​
project_id
string<uuid>
required
​
name
string
required
​
status
enum<string>
required
Available options:
active,
paused,
deleting
​
target
object
required
​
schedule
string
required
​
timezone
string
required
​
runtime_target_kind
enum<string>
required
Available options:
main_branch,
environment,
preview_branch
​
runtime_target_environment_id
string<uuid> | null
required
​
runtime_target_branch_id
string<uuid> | null
required
​
config
object
required
​
timeout_seconds
integer
required
​
backoff_limit
integer
required
​
concurrency_policy
string
required
​
last_scheduled_at
string | null
required
​
last_successful_at
string | null
required
​
created_by
string<uuid> | null
required
​
run_as_user_id
string<uuid> | null
required
​
created_at
string
required
​
updated_at
string
required