Update a Note
Lets you update an existing note. To use this API pass the following parameters in the JSON body of the request –
- “RelatedProspectId” (mandatory) – “ProspectId” or “LeadId”.
- “ProspectNoteId” (mandatory) – Id of the note you want to update.
- “Note” – The new note text.
- “AttachmentName” – This is the attachment URL to update if there is any.
Pass either “Note” or “AttachmentName”. You have to update either a note or an attachment to get a successful response.
If you need to upload a file to LeadSquared first, use Upload Files to Lead through API.
API URL
Request
Content-Type: application/json{ "RelatedProspectId": "ed477dea-d2fe-11e6-b5f1-22000aa8e760", "ProspectNoteId": "cf75b465-dcb2-11e6-b5f1-22000aa8e760", "Note": "Updated Note text", "AttachmentName": "provide a file URL here if any" }
Request Parameters
Parameter | Description |
---|---|
RelatedProspectId | “ProspectId” or “LeadId” of the lead. |
RelatedProspectId | The Id of the note you want to update. |
Note | The new note text. |
AttachmentName | The attachment URL. |
Response
{ "Status": "Success" }
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. |