Create Job
gorgias_create_jobCreate asynchronous Gorgias jobs to run long-running tasks in the background, including bulk ticket updates, macro application, exports, and imports.
Instructions
POST /api/jobs — Create a new asynchronous job. Jobs run in the background for long-running tasks such as bulk ticket updates, macro application, exports, and imports.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | No | Arbitrary key-value metadata to attach to the job (not used by Gorgias). Pass null to clear. | |
| type | Yes | The type of job to create | |
| params | Yes | Job-type-specific configuration parameters. REQUIRED. Structure depends on the type field — e.g. applyMacro needs macro_id + ticket_ids, updateTicket needs updates, importMacro needs url. | |
| scheduled_datetime | No | ISO 8601 datetime to schedule the job (max 60 minutes in the future). If omitted or null, queued for immediate execution. |