Update a Ticket with Attachments
Allows you to update and add attachments to an existing ticket.
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/{{ticketId}}/update
Method – PUT
Request Body
Content-Type: Multipart/form-data
Parameter | Type | Sample Values |
ticketDTO |
Text |
{ |
files |
File | The file you want to upload. You can add multiple files. |
Request Body Description
Property | Description |
TypeId | Pass ‘1’. This is mandatory. |
Id | Pass the ticket number. To obtain this, navigate to the Ticket Details Page, and copy the number. This is mandatory.![]() |
LeadId | Pass the LeadId . To obtain this, pass the Get a Lead by Email API. |
Fields | Pass the Schema Name of any system or custom ticket fields you want to update, along with their values. |
RelatedTicketTypeId | Pass ‘1’. This is mandatory. |
Files | Attach a file from your local storage. You can upload multiple files. |
Response
{ "Status":"Success", "ReasonForFailure":null, "Id":"143", "Message":"Ticket properties have been updated successfully", "Key":"#143", "TicketId":null }
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. |