API Reference

Update a job

put
https://{domain}.gorgias.com/api/jobs/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the job to update.

Body Params
meta
object | null

Metadata associated with the job. You can use this parameter to store structured information (key-value data) about the job. This field is not used by Gorgias.

params
object

The parameters of the job.

date-time | null

When the job was scheduled to be started. A job cannot be scheduled more than 60 minutes in the future. If unspecified, the job is queued for execution immediately after creation.

string
enum

The status of the job. Options: cancel_requested, canceled, done, errored, fatal_errored, pending, running, scheduled

Response

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago