Update a Custom Action

Lets you update an existing custom action for the Custom Lead and List Actions ConnectorYou need to pass the “ConnectorId” in the API URL.

API URL

POST
https://{host}/v2/Connector.svc/CustomAction/Update?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

{  
   "Id":"83ddba6d-17c9-414a-b1e4-876662836793",
   "Title":"2",
   "URL":"https://run.leadsquared.com/Settings/UserAccessKey",
   "Method":"POST",
   "ShowInWeb":true,
   "ShowInMobile":true,
   "RestrictedRoles":[  
      "Sales_User"
   ],
   "Data":"",
   "ActionType":"ManageListsRowAction",
   "ActionInvocationType":"OpenNewWindow"
}

JSON Properties

Parameter Description
Id

The unique Id of the custom action you want to update. Use the Get Custom Action API to retrieve it.

Title

The title of the custom action you want to update.

Method

This is the required HTTP method.

ShowInWeb

If set to “True”, the custom action is available in the web application of your LeadSquared account.

ShowInMobile

If set to “True”, the custom action is available in the mobile application of your LeadSquared account.

ActionType

Enter the type of action you want to update –

  • LeadGridRowAction – Creates a new lead grid action.
  • LeadGridBulkAction – Creates a new bulk lead grid action.
  • ManageListsRowAction – Creates a row action on the Manage Lists page.
ActionInvocationType

Enter the action invocation type that you want to update –

  • ShowPopup
  • CallAPI
  • OpenNewWindow

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "Message": "Custom Action updated 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.