Messages

4 endpoints in this category.

GET/messages/conversations

Get Conversations

Get the list of email-based messaging conversations.

Authentication:Required — Authorization: Bearer <token>

Response Fields

NameTypeRequiredDescription
dataConversation[]YesArray of conversations

Error Codes

StatusMeaning
401Unauthorized

Code Examples

curl -X GET 'https://visitnote-api-production.up.railway.app/api/therapist/v1/messages/conversations' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'
GET/messages/:conversationId

Get Messages

Get messages for a specific conversation with pagination.

Authentication:Required — Authorization: Bearer <token>

Path Parameters

NameTypeRequiredDescription
conversationIdintegerYesConversation ID

Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number
per_pageintegerNoMessages per page

Response Fields

NameTypeRequiredDescription
dataChatMessage[]YesArray of messages

Error Codes

StatusMeaning
404Conversation not found

Code Examples

curl -X GET 'https://visitnote-api-production.up.railway.app/api/therapist/v1/messages/:conversationId' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'
POST/messages/send

Send Message

Send an email-based message to a patient.

Authentication:Required — Authorization: Bearer <token>

Request Body

NameTypeRequiredDescription
patient_emailstringYesRecipient email
patient_namestringYesRecipient name
bodystringYesMessage body
subjectstringNoEmail subject
conversation_idintegerNoExisting conversation ID (for replies)

Error Codes

StatusMeaning
422Missing required fields

Code Examples

curl -X POST 'https://visitnote-api-production.up.railway.app/api/therapist/v1/messages/send' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "patient_email": "your_patient_email",
  "patient_name": "your_patient_name",
  "body": "your_body",
  "subject": "your_subject",
  "conversation_id": "your_conversation_id"
}'
PUT/messages/:conversationId/read

Mark Conversation as Read

Mark all messages in a conversation as read.

Authentication:Required — Authorization: Bearer <token>

Path Parameters

NameTypeRequiredDescription
conversationIdintegerYesConversation ID

Error Codes

StatusMeaning
404Conversation not found

Code Examples

curl -X PUT 'https://visitnote-api-production.up.railway.app/api/therapist/v1/messages/:conversationId/read' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'