One of the most powerful features of deskCRM is the REST API support. Using deskCRM Rest API, you can push sales leads to deskCRM from your existing website. This service is available free of cost (regular charges on sales leads volume apply).

To start configuring this service, you need following information:

  1. Your deskCRM Secret Key
  2. Access to your website source code
  3. Basic knowledge of HTML (you can approach your web developer also)

To access your deskCRM API Secret Key, visit your subscription page:

On Subscription page, under API Access Section, click on ‘Show’ to show your Secret Key and make note of the same:

The process of setting up API for support tickets is as follows:

  1. Design a support form on your website (or use existing one)
  2. Send a POST request to deskCRM Support Ticket API Endpoint in JSON format
  3. Read the JSON result to determine if the request was successful and fetch support ticket # to display to your visitor.

The deskCRM Sales Lead API endpoint is: https://deskcrm.com/api/crmLead

The format of request is as follows:

Field Name Data Type Data Limit Field Description
clientkey String 50 Your unique API Secret Key (Mandatory)
customer String 100 Name of your customer’s business (Mandatory)
description String 500 Message containing customer query (Mandatory)
productsku String 50 A product SKU as defined in products library of deskCRM. (Mandatory)
contact String 100 Name of primary contact person
email String 100 E-Mail address of contact person
mobile Numeric 12 Mobile or Phone Number
phone String 100 Alternate Phone/Fax Contact Number
updatecustomer Boolean NA Send True if the customer details submitted with the request are to be saved as a customer record in deskCRM Customer library
sendemail Boolean NA Indicates if and e-mail should be sent to the customer’s email address acknowledging receipt of their query. The e-mail address field should not be empty for this to work.
sendsms Boolean NA Indicates if and SMS should be sent to the customer’s mobile number acknowledging receipt of their query. The mobile number field should not be empty for this to work.
expsales Numeric 12 Amount of expected sales
sourceid Numeric 18 ID of one of the sales sources defined in your account. If skipped, default source will be picked.
regionid Numeric 18 ID of one of the sales regions defined in your account. If skipped, default region will be picked.
campaignid Numeric 18 ID of one of the sales campaigns defined in your account. If skipped, default campaign will be picked.
udf1 String 50 Value for User Defined Field 1
udf2 String 50 Value for User Defined Field 2
udf3 String 50 Value for User Defined Field 3
udf4 String 50 Value for User Defined Field 4
udf5 String 50 Value for User Defined Field 5
udf6 String 50 Value for User Defined Field 6
udf7 String 50 Value for User Defined Field 7
udf8 String 50 Value for User Defined Field 8
udf9 String 50 Value for User Defined Field 9
udf10 String 50 Value for User Defined Field 10

Once you send the post request with above formatted data, the server will send a response in JSON format as follows:

bResult: Boolean – True if lead created, False if lead creation failed
sResult: String – Error message if lead creation failed
iCidno: Numeric – If lead creation was successful, the ID of lead created else zero
iAutouid: Numeric – If lead creation was successful, the System ID of lead created else zero. This ID is not useful except for some troubleshooting purposes

Sample Response:

{ 
"bResult": true, 
"sResult": "", 
"iAutouid": 9999,
"iCidno": 1001
}

Please note:

This endpoint supports 10 tickets per minute for one account.  The abuse of this endpoint may result in suspension and blacklisting of your account and/or IP address.

0 replies

Leave a Reply

Want to join the discussion?
Feel free to contribute!

Leave a Reply

Your email address will not be published. Required fields are marked *