LeadSquared Developer Centre

ON THIS PAGE

Delete an Activity Type

This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Run in Postman

Delete a custom activity type from your account. You have to pass the “EventCode” of the activity in the API URL.

Note: If the custom activity type is associated with any leads, it gets deactivated. If the activity type isn’t associated with any leads, it gets deleted.

API URL

URL
Icon
GET https://{host}/v2/ProspectActivity.svc/CustomActivity/Delete?accessKey=AccessKey&secretKey=SecretKey&code=Code

URL Parameters

Parameter Description
Code This is the unique event code of the custom activity type. To get the activity code, refer to the Get List of Activity Types API.

Response

200 OK
Content-Type: application/json
{
    "Status": "Success",
    "Message": {
        "Message": "The Activity seems to be in use. Hence the activity is deactivated."
    }
}

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

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