Skip to main content
POST
/
conversation
/
{conversationId}
/
notes
Add a new note to a conversation.
curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversation/{conversationId}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>"
}'
{
  "id": 123,
  "conversation_id": 123,
  "text": "<string>",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
conversationId
integer
required

Body

application/json
​
text
string

Response

200 - application/json

Success

Note within a conversation. Only visible to business.

​
id
integer

Internal ID.

​
conversation_id
integer
​
text
string

Note content.

​
created_at
string<date-time> | null
Example:

"2023-01-01T12:00:00Z"

​
updated_at
string<date-time> | null
Example:

"2023-01-01T12:00:00Z"