Get a Lead’s Notes

Returns the notes associated with a lead. To use this API –

  • Pass the “RelatedId” (Mandatory) in the JSON body. This is the “LeadId” or the “ProspectId” of the lead whose notes you wish to retrieve.
  • Pass the “Id” (Optional) of a particular note you wish to retrieve in the JSON body. If you don’t pass this Id, all the lead’s notes will be retrieved.

API URL

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

Request

JSON Body/Payload

Content-Type: application/json

{
    "Parameter": {
        "RelatedId": "06a854bf-cd64-4328-abec-2968fd5e1232",
"Id": "5b25bd3d-cb2f-11e6-b5f1-22000aa8e760"
    },
    "Paging": {
        "PageIndex": 1,
        "PageSize": 200
    },
    "Sorting": {
        "ColumnName": "CreatedOn",
        "Direction": 1
    }
}

JSON Properties

Parameter Description
RelatedId

Pass the “LeadId” or “ProspectId” of the lead here.

Id

Pass the Id of a particular note here.

PageIndex

The results matching your criteria may be large. You can fetch the result in blocks of “PageSize” and make multiple calls to the API with increasing values of “PageIndex”.  For example, you can specify “PageIndex”: 1, “PageSize”: 100 for the first call and specify “PageIndex”: 2, “PageSize”: 100 for the second call.

PageSize

The column on which results will be sorted. For example, if you want results to be shown in descending order of lead creation date then use “CreatedOn”  in “ColumnName” and choose “Direction” as “1”.  Direction “1” implies descending order and “0” means ascending order.

ColumnName

The column on which results will be sorted. For example, if you want results to be shown based on creation date, pass “CreatedOn”.

Direction

Direction “1” means descending order and “0” means ascending order.

Response

200 OK

Content-Type: application/json

 {
      "ProspectNoteId": "5060d736-cb2f-11e6-b5f1-22000aa8e760",
      "RelatedProspectId": "06a854bf-cd64-4328-abec-2968fd5e1232",
      "Note": "Hi, this is test note created through soap ui.",
      "AttachmentName": "https://image.jpg",
      "AttachmentURL": "https://d24cdstip7q8pz.cloudfront.net/t/mainjee1/content/module/lead/06a854bf-cd64-4328-abec-2968fd5e1232/https://image.jpg",
      "CreatedBy": "57fe8a45-b8de-11e5-a199-22000aa4133b",
      "CreatedByName": "chetna",
      "CreatedOn": "2016-12-26 05:51:15",
      "ModifiedBy": "57fe8a45-b8de-11e5-a199-22000aa4133b",
      "ModifiedByName": "chetna",
      "ModifiedOn": "2016-12-26 05:51:15"
    }
  ],
  "RecordCount": 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.