Mark Lead Invalid

Lets you mark a lead as ‘Invalid’. Leads marked invalid won’t receive any email communication. To use this API –

  • Pass the Email address of the Lead in the JSON body.
  • Pass a note or reason (optional).

If the API call is successful, you’ll see a message appear above the lead’s vCard and your notes in the Activity History and Notes tabs on the Lead Details page –

LEad Marked Invalid Message on Ui

API URL

POST
https://{host}/v2/LeadManagement.svc/MarkEmailInvalid?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
"EmailAddress": "example@example.com",
"Message": "Example Message"
}

JSON Properties

Parameter Description
EmailAddress

The lead’s email address registered with LeadSquared.

Message

Any notes or reasons pertaining to marking the lead ‘Invalid’.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "AffectedRows": 1
    }
}

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.