Create a Custom Tab

Lets you create a new tab for the Custom Tab Connector. Pass the “ConnectorId” in the API URL.

Note: You can restrict a particular user role from accessing the custom tab by specifying the user role type in the JSON body.

API URL

POST
https://{host}/v2/Connector.svc/CustomTab/Create?accessKey=AccessKey&secretKey=SecretKey&connectorId=ConnectorId
Copy URL

URL Parameters

Parameter Description
ConnectorId Please contact support@leadsquared.com in order to get this

Request

JSON Body/Payload

Content-Type: application/json

{  
   "Title":"Sample Custom Tab",
   "URL":"https://run.leadsquared.com/Settings/ManageUsers",
   "ShowInWeb":true,
   "ShowInMobile":true,
   "RestrictedRoles":[  
      "Sales_User"
   ]
}

JSON Properties

Parameter Description
Title

The custom tab title.

URL

The webhook URL which is rendered as a custom tab.

ShowInWeb

If set to “True”, the custom tab will be available in the web application of your LeadSquared account.

ShowInMobile

If set as “True”, the custom tab will be available in the mobile application of your LeadSquared account.

RestrictedRoles

Specify the user roles that you want to restrict for the custom tab.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "Id": "Id",
        "Message": "Custom Tab created successfully"
    }
}

HTTP Response Code

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.