mutation · Module: Jobs · Requires jobs:write
Arguments
Returns
JobSchedule!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
mutation ResumeJobSchedule($id: ID!) {
resumeJobSchedule(id: $id) {
id
object
status
type
livemode
created
updated
recurrence {
frequency
interval
days
day_of_month
times
timezone
}
overlap
next_run_at
last_job
last_status
}
}
{
"id": "jsch_1a2B3c"
}
{
"data": {
"resumeJobSchedule": {
"id": "jsch_1a2B3c",
"object": "job_schedule",
"status": "active",
"type": "example",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"recurrence": {
"frequency": "daily",
"interval": 2,
"days": [
"mon"
],
"day_of_month": 2,
"times": [
"example"
],
"timezone": "Europe/London"
},
"overlap": "skip",
"next_run_at": 1791302400,
"last_job": "example",
"last_status": "queued"
}
}
}
Job schedule: resume
mutation ResumeJobSchedule($id: ID!) {
resumeJobSchedule(id: $id) {
id
object
status
type
livemode
created
updated
recurrence {
frequency
interval
days
day_of_month
times
timezone
}
overlap
next_run_at
last_job
last_status
}
}
{
"id": "jsch_1a2B3c"
}
{
"data": {
"resumeJobSchedule": {
"id": "jsch_1a2B3c",
"object": "job_schedule",
"status": "active",
"type": "example",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"recurrence": {
"frequency": "daily",
"interval": 2,
"days": [
"mon"
],
"day_of_month": 2,
"times": [
"example"
],
"timezone": "Europe/London"
},
"overlap": "skip",
"next_run_at": 1791302400,
"last_job": "example",
"last_status": "queued"
}
}
}
mutation · Module: Jobs · Requires jobs:write
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
JobSchedule!
| Field | Type |
|---|---|
id | String! |
object | JobScheduleObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
status | JobScheduleStatus! |
type | String! |
parameters | JSON |
recurrence | Recurrence! |
overlap | JobScheduleOverlap |
next_run_at | Int |
last_job | String |
last_status | JobScheduleLastStatus |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation ResumeJobSchedule($id: ID!) {
resumeJobSchedule(id: $id) {
id
object
status
type
livemode
created
updated
recurrence {
frequency
interval
days
day_of_month
times
timezone
}
overlap
next_run_at
last_job
last_status
}
}
{
"id": "jsch_1a2B3c"
}
{
"data": {
"resumeJobSchedule": {
"id": "jsch_1a2B3c",
"object": "job_schedule",
"status": "active",
"type": "example",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"recurrence": {
"frequency": "daily",
"interval": 2,
"days": [
"mon"
],
"day_of_month": 2,
"times": [
"example"
],
"timezone": "Europe/London"
},
"overlap": "skip",
"next_run_at": 1791302400,
"last_job": "example",
"last_status": "queued"
}
}
}