Create Note
POST /v1/notes
/v1/notesCreate a note
Creates a note and attaches it to one or more prospects. To create a note for a single prospect, provide prospectId. To create the same note for multiple prospects in one request, provide prospectIds 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.
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Request Body
application/jsonRequiredProvide content (required), visibility (required), and prospectIds (required) — pass a single-element array for one prospect, or multiple IDs to attach the same note to several prospects in one request. visibility accepted values: "1" = Public (visible to all team members), "2" = Private (visible only to you). status accepted values: "0" = Draft, "1" = Published. Defaults to "1". attachmentIds (optional) accepts attachment IDs returned by POST /v1/notes/attachments.
contentstring
The content of the note. Supports plain text and HTML.
Example:"Follow up with this prospect next week regarding the demo."visibilitystring
Who can see this note. Use "1" for public (visible to all team members) or "2" for private (visible only to you).
Example:"1"Value in: "1" | "2"prospectIdsarray<string>
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.
Example:["8PvBmrB7P7"]attachmentIdsarray<string>
IDs of attachments to associate with this note. Upload via POST /v1/notes/attachments to obtain each attachmentId.
Example:["Aw83gqRXvk","BV4yLpC2nX"]statusstring
The status of the note. Use "0" for draft or "1" for published. Defaults to "1" (published) if not provided.
Example:"1"Default: "1"Value in: "0" | "1"Request Body Examples
{
"content": "Follow up with this prospect next week regarding the demo.",
"visibility": "1",
"prospectIds": [
"8PvBmrB7P7"
]
}Responses
{
"message": "Notes created successfully",
"payload": {
"results": [
{
"prospectId": "Pr9xQ2Lm",
"noteId": "Nt7Yp4Za",
"success": true
},
{
"prospectId": "Pr4Kb8Qw",
"noteId": "Nt4Kb8Qw",
"success": true
},
{
"prospectId": "INVALIDxx",
"noteId": null,
"success": false
}
]
}
}