Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Notes

Create Note

Creates a note on the target lead.

Notes:

  • leadId, content and isPin are required; content must not be blank.
  • content is silently truncated to 2000 characters.
  • Caller must have access to the lead; otherwise 404 LEAD_NOT_EXIST.
  • The response contains only the new note's ID under the 'noteId' key.
  • Persistence is asynchronous: subsequent GET and PUT on the returned noteId may briefly return 404 immediately after create. DELETE is unaffected.
post/v1.0/notes

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 created. Response contains the new note's ID.

noteIdinteger

ID of the newly created note.

Example response

{
  "noteId": 563172647619608
}