LeadSquared Developer Centre

ON THIS PAGE

Lock an Activity


This API lets you lock an activity and prevent it from being edited or deleted. You may use it to lock an activity after a certain stage/status change (for example, from pending to approved).

Note:

To lock an activity, you must first enable the lock activity feature for that activity type –

  1. Navigate to My Profile>Settings>Leads>Custom Activities & Scores.
  2. Alongside an existing activity, click Edit.
    • For a new custom activity, click Add.
  3. On the Add/Update Custom Activity Type pop-up, alongside Lock Activity, enable the checkbox Checkbox.
  4. Then select the user roles for which you want to lock the activity. These users won’t be able to edit or delete the activity once locked.
  5. Click Next, and then click Save.

Lock Activity

 

API URL

URL
Icon
GET https://{host}/v2/ProspectActivity.svc/CustomActivity/Lock? accessKey=AccessKey&secretKey=SecretKey&activityId=ActivityId

URL Parameters

Parameter Description
ActivityId The unique identifier of the activity.

Response

200 OK
Content-Type: application/json
							
								

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

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