notes

Create a note

Creates a note and attaches it to one or more prospects. To create a note for a single prospect, provide <code>prospectId</code>. To create the same note for multiple prospects in one request, provide <code>prospectIds</code> as an array — the response will include a results array with the outcome for each prospect, so a failure for one prospect does not affect the others.

post/v1/notes

Request body

contentstring required

The content of the note. Supports plain text and HTML.

visibility'1' | '2' required

Who can see this note. Use "1" for public (visible to all team members) or "2" for private (visible only to you).

prospectIdsstring[] required

List of prospect IDs to attach the note to. Pass a single-element array for a single prospect, or multiple IDs to attach the same note to several prospects in one request.

attachmentIdsstring[]

IDs of attachments to associate with this note. Upload via POST /v1/notes/attachments to obtain each attachmentId.

status'0' | '1'

The status of the note. Use "0" for draft or "1" for published. Defaults to "1" (published) if not provided.

Example request

{
  "content": "Follow up with this prospect next week regarding the demo.",
  "visibility": "1",
  "prospectIds": [
    "8PvBmrB7P7"
  ],
  "attachmentIds": [
    "Aw83gqRXvk",
    "BV4yLpC2nX"
  ],
  "status": "1"
}

Response

Note created successfully

{"stackTrail":"paths:/v1/notes:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Notes created successfully","payload":{"results":[{"prospectId":"Pr9xQ2Lm","noteId":"Nt7Yp4Za","success":true},{"prospectId":"Pr4Kb8Qw","noteId":"Nt4Kb8Qw","success":true},{"prospectId":"INVALIDxx","noteId":null,"success":false}]}}}

Example response

{
  "message": "Notes created successfully",
  "payload": {
    "results": [
      {
        "prospectId": "Pr9xQ2Lm",
        "noteId": "Nt7Yp4Za",
        "success": true
      },
      {
        "prospectId": "Pr4Kb8Qw",
        "noteId": "Nt4Kb8Qw",
        "success": true
      },
      {
        "prospectId": "INVALIDxx",
        "noteId": null,
        "success": false
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.