Show Note by ID - Chat API

GET

conversation

{conversationId}

notes

{noteId}

Show note by ID within a conversation.

curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversation/{conversationId}/notes/{noteId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "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

Response

200 - application/json

Success

data

object

Note within a conversation. Only visible to business.

Show child attributes

Update Note by IDUpdate a note within a conversation.

Show note by ID within a conversation.

curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversation/{conversationId}/notes/{noteId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "conversation_id": 123,
    "text": "<string>",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:00Z"
  }
}