LeadSquared Developer Centre

ON THIS PAGE

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 –

  1. On your LeadSquared account, navigate to My Profile>Settings>Service Cloud, and click API Configurations.
  2. Alongside Enable API, enable the slider LeadSquared Service CRM APIs.
    • Alongside Enable IP Whitelisting, enable the slider and add the IPs you want to whitelist. This is optional.
  3. Once you’re done, click Save.

LeadSquared Service CRM_API Configurations

Note: To obtain the host API URL, contact your account manager, or write to scsupport@leadsquared.com.

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

MethodPOST

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
  • For an existing lead, pass the LeadId. To obtain this, pass the Get a Lead by Email API.
  • For a lead that’s not present in LeadSquared, pass this array with relevant details. This should mandatorily include one lead identifier (like Email, Phone, etc.) –

[
{
"SchemaName":"LeadDetail.Phone",
"Value":""
},
{
"SchemaName":"LeadDetail.EmailAddress",
"Value":"wim@example.com"
},
{
"SchemaName":"LeadDetail.Mobile",
"Value":""
},
{
"SchemaName":"<Custom Lead Field Schema>",
"Value":""
}
]

Fields Pass the following ticket fields, along with their values.

  • Title
  • Status*
  • Priority*
  • Channel*
  • Description (This is optional)
  • Schema name of a custom ticket field (This is optional)
Note: *Pass only values configured in your account.
RelatedTicketTypeId Pass ‘1’.
Files Attach a file from your local storage. You can upload multiple files.

LeadSquared Service CRM

API URL

URL
Icon
POST https://apigw.service-in.leadsquared.com/api/tenants/{{orgId}}/tickets

Response

200 OK
Content-Type: application/json
{
   "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.

On this page

© 2024 by MarketXpander Services Pvt Ltd. All Rights Reserved.