Create a Custom Opportunity Tab
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Lets you create a custom tab for the Custom Opportunity 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
URL
POST
https://{host}/v2/Connector.svc/Opportunity/CustomTab/Create?accessKey=AccessKey&secretKey=SecretKey&connectorId=ConnectorId
URL Parameters
| Parameter | Description |
|---|---|
| ConnectorId | Please contact support@leadsquared.com for the connector id. |
Request
Content-Type: application/jsonJSON Body/Payload
{
"EntityType":"12000",
"Title": "Custom tab 1",
"RestrictedRoles": [
"SalesUser"
],
"URL": "https://forms.office.com/Pages/ResponsePage.aspx?id=YsdjOZS3lkyQUPR9nal2OO6QtoQoa9tLs6T5EkzgYOFUOTBEWUZKTkFSOTRQU0MwV0JPVDNIRDU2NS4u",
"ShowInWeb": true,
"ShowInMobile": true
}
Request Parameters
| Parameter | Description |
|---|---|
| EntityType | The Opportunity Type Code. You can find this on the Opportunity Types Setting page. |
| Title | The custom tab title |
| RestrictedRoles | Specify the user roles that you want to restrict for the custom tab. You can restrict the following roles – Sales Manager, Sales User, and Marketing User. |
| URL | The URL 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. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"Id": "eca5e2bf-d27e-494e-ac13-1e4be0677774433",
"Message": "Custom Tab created successfully"
}
}
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. |
