Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Notes

Update Note

Updates the content and pin state of an existing note.

Notes:

  • content must not be blank; isPin must not be null.
  • content is silently truncated to 2000 characters.
  • If leadId is supplied in the body, it must match the note's lead; otherwise 400 INVALID_UPDATE_OPERATION_LEADID.
  • Caller must have access to the lead; otherwise 404 LEAD_NOT_EXIST.
  • The response body is empty.
put/v1.0/notes/{noteId}

Path parameters

noteIdinteger required

ID of the note to update.

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

contentstring required

Note content. Silently truncated to 2000 characters.

leadIdinteger required

ID of the lead this note belongs to. Must be accessible to the caller.

isPinboolean required

Whether to pin this note to the top of the lead's timeline.

Example request

{
  "content": "Discussed Austin inventory, will send pre-approval doc tomorrow.",
  "leadId": 563172647619608
}

Response

Note updated successfully. No response body.