Create Ticket with Attachments
Allows you to create a new ticket with attachments.
Prerequisite
Before you pass this API, the API Configurations setting must be enabled on your account. To do this –
- On your LeadSquared account, navigate to My Profile>Settings>Service Cloud, and click API Configurations.
- Alongside Enable API, enable the slider
.
- Alongside Enable IP Whitelisting, enable the slider and add the IPs you want to whitelist. This is optional.
- Once you’re done, click Save.
Pass the following mandatory API headers –
- X-LSQ-ACCESS-KEY – <AccessKey>
- X-LSQ-SECRET-KEY – <SecretKey>
API URL
https://apigw.service-in.leadsquared.com/api/tenants/{{orgId}}/tickets
Method – POST
Request Body
Content-Type: Multipart/form-data
Parameter | Type | Sample Values |
ticketDTO |
Text |
{ "TypeId":"1", "LeadId":"8eee83bb-0462-4d6b-b396-6afb9a4608f2", "Fields":[ { "SchemaName":"Title", "Value":"Ticket creation through APIs" }, { "SchemaName":"Description", "Value":"This ticket was created using the Attachments API" }, { "SchemaName":"Status", "Value":"Open" }, { "SchemaName":"Priority", "Value":"Low" }, { "SchemaName":"Channel", "Value":"Email" } ], "RelatedTicketTypeId":1 } |
files |
File | The file you want to upload. You can add multiple files. |
Request Body Description
Property | Description |
TypeId | Pass ‘1’. |
LeadId |
|
Fields | Pass the following ticket fields, along with their values.
Note: *Pass only values configured in your account.
|
RelatedTicketTypeId | Pass ‘1’. |
Files | Attach a file from your local storage. You can upload multiple files. |
API URL
Response
{ "Status":"Success", "ReasonForFailure":null, "Id":"157", "Message":"Ticket has been created successfully", "Key":"#157", "TicketId":"5af882cc-49c8-403f-8dba-c7e356e9baf7" }
HTTP Response Codes
Code | Description |
---|---|
200 OK | This is the status code for successful API call. |
401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
404 Not Found | The API could not be found. Please check the API signature. |
429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |