Create a job

post https://{domain}.gorgias.com/api/jobs

Create a job and schedule its execution. Jobs are processed asynchronously, meaning that once a job is created, it will run in background on Gorgias's servers. According to the type and size of the task, a job can take a few minutes or several hours to be executed. You can use our API to check the status of the job.

Response

Response body

object

integer

ID of the job.

cancel_requested_datetime

date-time | null

When the job cancellation was requested.

cancelled_datetime

date-time | null

When the job was canceled.

created_datetime

date-time | null

When the job was created.

ended_datetime

date-time | null

When the job ended.

failed_datetime

date-time | null

When the job failed.

info

object

Data concerning the progress of the job. E.g: how many objects the job has already processed.

Has additional fields

locked_datetime

date-time | null

When the job was locked. A job is only locked while it's actively running.

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.

Has additional fields

params

object

The parameters of the job.

apply_and_close

boolean

Whether the ticket should be closed once the macro is applied on it. Only applies to applyMacro jobs.

end_datetime

string | null

End of the interval from which to select tickets when the parameter view is used.

macro_id

integer

The ID of the macro to apply on the selected tickets. Only applies to applyMacro jobs.

start_datetime

string | null

Beginning of the interval from which to select tickets when the parameter view is used.

ticket_ids

array of integers

A list of ticket IDs to be processed by the job.

ticket_ids

url

string

The path to the file to import.

updates

object

Object (key-value) containing all the changes to apply on the selected tickets. Only applies to updateTicket jobs.

Has additional fields

view

object

A view-like object used to select the tickets to be processed by the job.

Has additional fields

view_id

integer

The ID of an existing view used to select the tickets to be processed by the job.

context

object

Object (key-value) containing extra context for the job

Has additional fields

scheduled_datetime

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.

started_datetime

date-time | null

When the job started.

status

string

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

cancel_requested canceled done errored fatal_errored pending running scheduled

type

string

The type of the job. Options: applyMacro, deleteTicket, exportTicket, importMacro, exportMacro, updateTicket, exportTicketDrilldown, exportConvertCampaignSalesDrilldown

applyMacro deleteTicket exportTicket importMacro exportMacro updateTicket exportTicketDrilldown exportConvertCampaignSalesDrilldown

user_id

integer

The ID of the user who created this job.

uri

string

URI of the job.

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://your-domain.gorgias.com/api/jobs \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "applyMacro"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created job.