POST /api/v2/imports/tickets
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
archive_immediately |
Boolean | No |
If |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ticket |
Object | No | |
ticket.external_id |
String | No |
An id you can use to link Zendesk Support tickets to local records |
ticket.email_ccs[] |
Array | No |
An array of objects that represent agent or end users email CCs to add or delete from the ticket. See Setting email CCs |
ticket.email_ccs[].action |
String | No |
Valid values:
|
ticket.email_ccs[].user_email |
String | No | |
ticket.email_ccs[].user_name |
String | No | |
ticket.email_ccs[].user_id |
String | No | |
ticket.via |
Object | No |
An object explaining how the ticket was created. See the Via object reference |
ticket.via.source |
Object | No |
For some channels a source object gives more information about how or why the ticket or event was created |
ticket.via.channel |
String | No |
This tells you how the ticket or event was created |
ticket.description |
String | No |
Read-only first comment on the ticket. When creating a ticket, use |
ticket.status |
String | No |
The state of the ticket Valid values:
|
ticket.subject |
String | No |
The value of the subject field for this ticket |
ticket.followers[] |
Array | No |
An array of objects that represent agent followers to add or delete from the ticket. See Setting followers |
ticket.followers[].action |
String | No |
Valid values:
|
ticket.followers[].user_email |
String | No | |
ticket.followers[].user_name |
String | No | |
ticket.followers[].user_id |
String | No | |
ticket.recipient |
String | No |
The original recipient e-mail address of the ticket |
ticket.updated_at |
String | No |
The time the ticket was last updated (for historical imports) |
ticket.requester_id |
Integer | No |
The user who requested this ticket |
ticket.assignee_id |
Integer | No |
The agent currently assigned to the ticket |
ticket.collaborators[] |
Array | No |
Users to add as cc's when creating a ticket. See Setting Collaborators |
ticket.collaborators[].email |
String | No | |
ticket.collaborators[].name |
String | No | |
ticket.tags[] |
Array | No |
The array of tags applied to this ticket |
ticket.solved_at |
String | No |
The time the ticket was solved (for historical imports) |
ticket.created_at |
String | No |
The time the ticket was created (for historical imports) |
ticket.custom_status_id |
Integer | No |
The custom ticket status id of the ticket |
ticket.custom_fields[] |
Array | No |
Custom field values to set on the ticket. Each entry specifies a field ID and its value. |
ticket.custom_fields[].id |
Integer | Yes |
The ID of the custom field |
ticket.custom_fields[].value |
No |
The value to assign to the custom field. Type depends on the field configuration:
|
|
ticket.comments[] |
Array | No |
The conversation between requesters, collaborators, and agents |
ticket.comments[].via |
Object | No |
Describes how the object was created. See the Via object reference |
ticket.comments[].via.source |
Object | No |
For some channels a source object gives more information about how or why the ticket or event was created |
ticket.comments[].via.channel |
String | No |
This tells you how the ticket or event was created. Examples: "web", "mobile", "rule", "system" |
ticket.comments[].public |
Boolean | No |
true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it |
ticket.comments[].add_short_url |
Boolean | No |
Internal flag for adding short URLs to the comment |
ticket.comments[].metadata |
Object | No |
System information (web client, IP address, etc.) and comment flags, if any. See Comment flags |
ticket.comments[].value |
String | No |
The comment string value |
ticket.comments[].id |
Integer | No |
Automatically assigned when the comment is created |
ticket.comments[].plain_body |
String | No |
The comment presented as plain text. See Bodies |
ticket.comments[].translate_to |
String | No |
The locale code to translate the comment body to. |
ticket.comments[].attachments[] |
Array | No |
Attachments, if any. See Attachment |
ticket.comments[].attachments[].content_type |
String | No |
The content type of the image. Example value: "image/png" |
ticket.comments[].attachments[].inline |
Boolean | No |
If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false |
ticket.comments[].attachments[].size |
Integer | No |
The size of the image file in bytes |
ticket.comments[].attachments[].deleted |
Boolean | No |
If true, the attachment has been deleted |
ticket.comments[].attachments[].height |
Integer | No |
The height of the image file in pixels. If height is unknown, returns null |
ticket.comments[].attachments[].url |
String | No |
A URL to access the attachment details |
ticket.comments[].attachments[].width |
Integer | No |
The width of the image file in pixels. If width is unknown, returns null |
ticket.comments[].attachments[].thumbnails[] |
Array | No |
An array of attachment objects. Note that photo thumbnails do not have thumbnails |
ticket.comments[].attachments[].thumbnails[].content_type |
String | No |
The content type of the image. Example value: "image/png" |
ticket.comments[].attachments[].thumbnails[].inline |
Boolean | No |
If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false |
ticket.comments[].attachments[].thumbnails[].size |
Integer | No |
The size of the image file in bytes |
ticket.comments[].attachments[].thumbnails[].deleted |
Boolean | No |
If true, the attachment has been deleted |
ticket.comments[].attachments[].thumbnails[].height |
Integer | No |
The height of the image file in pixels. If height is unknown, returns null |
ticket.comments[].attachments[].thumbnails[].url |
String | No |
A URL to access the attachment details |
ticket.comments[].attachments[].thumbnails[].width |
Integer | No |
The width of the image file in pixels. If width is unknown, returns null |
ticket.comments[].attachments[].thumbnails[].malware_access_override |
Boolean | No |
If true, you can download an attachment flagged as malware. If false, you can't download such an attachment. |
ticket.comments[].attachments[].thumbnails[].mapped_content_url |
String | No |
The URL the attachment image file has been mapped to |
ticket.comments[].attachments[].thumbnails[].file_name |
String | No |
The name of the image file |
ticket.comments[].attachments[].thumbnails[].content_url |
String | No |
A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See Working with url properties |
ticket.comments[].attachments[].thumbnails[].id |
Integer | No |
Automatically assigned when created |
ticket.comments[].attachments[].thumbnails[].malware_scan_result |
String | No |
The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: "malware_found", "malware_not_found", "failed_to_scan", "not_scanned" |
ticket.comments[].attachments[].malware_access_override |
Boolean | No |
If true, you can download an attachment flagged as malware. If false, you can't download such an attachment. |
ticket.comments[].attachments[].mapped_content_url |
String | No |
The URL the attachment image file has been mapped to |
ticket.comments[].attachments[].file_name |
String | No |
The name of the image file |
ticket.comments[].attachments[].content_url |
String | No |
A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See Working with url properties |
ticket.comments[].attachments[].id |
Integer | No |
Automatically assigned when created |
ticket.comments[].attachments[].malware_scan_result |
String | No |
The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: "malware_found", "malware_not_found", "failed_to_scan", "not_scanned" |
ticket.comments[].author_id |
Integer | No |
The id of the comment author. If null or omitted on create, defaults to the authenticated user. See Author id |
ticket.comments[].audit_id |
Integer | No |
The id of the ticket audit record. See Show Audit |
ticket.comments[].body |
String | No |
The comment string. See Bodies |
ticket.comments[].channel_back |
String | No |
Internal channel back identifier for the comment |
ticket.comments[].type |
String | No |
|
ticket.comments[].html_body |
String | No |
The comment formatted as HTML. See Bodies |
ticket.comments[].uploads[] |
Array | No |
List of tokens received from uploading files for comment attachments. The files are attached by creating or updating tickets with the tokens. See Attaching files in Tickets |
ticket.comments[].created_at |
String | No |
The time the comment was created |
ticket.comments[].channel_source_id |
String | No |
Internal channel source identifier for the comment |
ticket.group_id |
Integer | No |
The group this ticket is assigned to |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.