Create a ticket
POST {{baseUrl}}/api/v1/tickets
This API creates a ticket in your helpdesk.
OAuth Scope
Desk.tickets.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| subject (required) | <string> max chars : 255 | Subject of the ticket |
| departmentId (required) | <long> | ID of the department to which the ticket belongs |
| contactId | <referred object> | ID of the contact who raised the ticket. If a value is not available for this key, make sure to include the contact JSON object. If neither attribute is available, an error message regarding the unavailability of the contactId message is returned. |
| contact | <Contact> | Details of the contact who raised the ticket. This object is used for automatically creating a contact when a ticket is received. If the email ID of the contact already exists in your portal, the corresponding contactId is used for creating the ticket. Else, a contact is first created and the contactId of the new contact is mapped to the ticket. The user’s profile and field permissions are considered in the contact creation process. Either the lastName or the email attribute must be present in the object. |
| productId | <referred object> | ID of the product to which the ticket is mapped |
| uploads | <list> | File attachments in the ticket. For more information, refer to the Uploads section |
| <string> max chars : 150 | Email ID in the ticket | |
| phone | <string> max chars : 120 | Phone number in the ticket |
| description | <string> max chars : 65535 | Description in the ticket |
| status | <string> max chars : 120 | Status of the ticket. Includes the custom statuses configured in your help desk portal. |
| assigneeId | <long> | ID of agent to whom the ticket is assigned |
| category | <string> max chars : 300 | Category of the ticket |
| subCategory | <string> max chars : 300 | Subcategory of the ticket |
| resolution | <string> max chars : 65535 | Resolution notes recorded in the ticket |
| dueDate | <timestamp> | Due date for resolving the ticket |
| priority | <string> max chars : 120 | Priority of the ticket |
| language | <string> max chars : 255 | Language preference to set for the ticket |
| responseDueDate | <string> max chars : 100 | Date on or before which a response must be sent for the ticket |
| channel | <string> max chars : 120 | Channel through which the ticket originated. |
| classification | <string> max chars : 100 | Type of ticket. Values supported are Problem, Request, Question, and Others. |
| customFields | <JSONObject> | Custom fields in the ticket |
| cf | <JSONObject> | Custom fields in the ticket |
| webUrl | <string> max chars : -1 | URL to access the resource |
| teamId | <long> | ID of the team assigned to resolve the ticket |
| secondaryContacts | <list> | Secondary contacts, such as CC'ed users, associated with the ticket |
| entitySkills | <list> | Comma-separated array of skill IDs to be mapped with a ticket. The order of IDs (with the first ID given the highest priority) will determine how assignments are calculated. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"entitySkills":["18921000000379001","18921000000364001","18921000000379055","18921000000379031"],"modifiedTime":"2016-06-21T12:50:04.000Z","ticketNumber":"773","subCategory":"Sub General","statusType":"Open","subject":"Real Time analysis Requirement","dueDate":"2016-06-21T18:50:04.573Z","departmentId":"1892000000006907","channel":"Email","onholdTime":null,"description":"Hai This is description","language":"English","source":{"appName":null,"extId":null,"type":"SYSTEM","permalink":null,"appPhotoURL":null},"resolution":null,"sharedDepartments":[],"closedTime":null,"sharedCount":"0","approvalCount":"0","timeEntryCount":"0","isOverDue":false,"channelRelatedInfo":null,"isDeleted":"false","isTrashed":false,"createdTime":"2016-06-21T12:50:04.000Z","id":"1892000001054003","email":"carol@zylker.com","channelCode":null,"customerResponseTime":"2013-11-04T11:21:07.912Z","cf":{"cf_permanentaddress":null,"cf_dateofpurchase":null,"cf_phone":null,"cf_numberofitems":null,"cf_url":null,"cf_secondaryemail":null,"cf_severitypercentage":"0.0","cf_modelname":"F3 2017"},"productId":null,"contactId":"1892000000042032","threadCount":"1","priority":"High","classification":null,"assigneeId":"1892000000056007","commentCount":"0","taskCount":"0","phone":"1 888 900 9646","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","attachmentCount":"0","isEscalated":false,"isSpam":false,"category":"general","status":"Open"}