POST
/
conversations
/
{conversationId}
/
notes

Example JS Code to Create a Note for a Conversation

const apiUrl = 'https://api.chatvolt.ai';
const apiKey = 'YOUR_API_KEY';
const conversationId = 'YOUR_CONVERSATION_ID';

const res = await fetch(
  `${apiUrl}/conversations/${conversationId}/notes`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Bearer ${apiKey}`,
    },
    body: JSON.stringify({
      note: 'This is a note created from the API.',
      isPrivate: false
    })
  }
);
const data = await res.json();
console.log(data);

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

conversationId
string
required

ID of the conversation to add a note to.

Body

application/json
note
string
required

Text content of the note (max 500 characters).

isPrivate
boolean
default: false

Whether the note is private.

isJustify
boolean
default: false

Whether the note is a justification (admin only).

notificationDateTime
string

Date and time for a notification, if any.

Response

201 - application/json
id
string
required
note
string
required
isPrivate
boolean
isJustification
boolean
conversationId
string
required
organizationId
string
required
userId
string
required
userEmail
string
required
notificationDateTime
string | null
sendDesktopNotification
boolean
createdAt
string
updatedAt
string