Create a Note

This API allows you to create a note and attach a file to a lead. To use this API you need to pass –

  • “RelatedProspectId” (mandatory) – This is the “ProspectId” or “LeadId” of the lead.
  • “Note” (mandatory) – This the note text you want to create.
  • AttachmentName (optional) – Attachment URL if any.

You can only pass the attachment URL in this API. If you want to upload a file first, see Upload Files to Lead Through API.

API URL

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

Request

JSON Body/Payload

Content-Type: application/json

{
    "RelatedProspectId": "d7988ca3-c5f7-11e6-b5f1-22000aa8e760",
    "Note": "Hi, this is a test note created through API.",
    "AttachmentName": "http://help.leadsquared.com/wp-content/uploads/2015/02/reports-home.png"
}

JSON Properties

Parameter Description
RelatedProspectId

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

Note

Pass the note text here.

AttachmentName

Pass the attachment URL here.

Response

200 OK

Content-Type: application/json

{
  "Status": "Success",
  "Message": {
    "Id": "d4c8f69f-c913-11e6-b5f1-22000aa8e760"
  }
}

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.