Update Note by ID

PATCH

conversation

{conversationId}

notes

{noteId}

Update a note within a conversation.

curl --request PATCH \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversation/{conversationId}/notes/{noteId} \
  --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

noteId

integer

required

Body

application/json

text

string

Response

200 - application/json

Success

Note within a conversation. Only visible to business.

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"

Delete Note by IDDelete note by ID within a conversation.

Update a note within a conversation.

curl --request PATCH \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversation/{conversationId}/notes/{noteId} \
  --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"
}