Skip to main content
POST
/
conversations
/
{id}
/
mark-read
Mark all messages in a conversation as read.
curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/conversations/{id}/mark-read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mark_external": true
}
'
{
  "data": {
    "id": 123,
    "created_at": "2023-01-01T12:00:00Z",
    "channel": "bridge",
    "status": "to-do",
    "snooze_until": "2023-01-01T12:00:00Z",
    "agent": {
      "id": 123,
      "channel": "bridge",
      "display_id": 4915223567929,
      "name": "John Doe",
      "in_sync": true,
      "unread_conversations_count": 123
    },
    "customer": {
      "id": 123,
      "channel": "bridge",
      "display_id": 4915223567929,
      "name": "John Doe",
      "profile": {
        "id": 123,
        "salutation": "formal_male",
        "name": "John Doe",
        "gender": "undisclosed",
        "blocked": true,
        "date_of_birth": "1970-01-01",
        "phone_number": "+4915224367929",
        "email": "[email protected]",
        "address": "<string>",
        "custom_1": "<string>",
        "custom_2": "<string>",
        "custom_3": "<string>",
        "custom_4": "<string>",
        "custom_5": "<string>",
        "created_at": "2023-01-01T12:00:00Z",
        "updated_at": "2023-01-01T12:00:00Z"
      }
    },
    "user": {
      "id": 123,
      "name": "<string>",
      "email": 123,
      "roles": [
        "<string>"
      ],
      "permissions": [
        "<string>"
      ],
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:00:00Z"
    },
    "latest_message": {
      "id": 123,
      "conversation_id": 123,
      "from": "system",
      "source": "user",
      "user_id": 123,
      "contents": [
        "<unknown>"
      ],
      "status": "created",
      "agent_reaction": "<string>",
      "customer_reaction": "<string>",
      "sent_at": "2023-01-01T12:00:00Z",
      "reference": "<unknown>",
      "latest_error": {
        "id": 123,
        "message_id": 123,
        "type": "status-update",
        "original_message": "<string>",
        "created_at": "2023-01-01T12:00:00Z"
      },
      "whatsapp_campaign": {
        "id": 123,
        "name": "<string>"
      }
    },
    "latest_customer_message": {
      "id": 123,
      "conversation_id": 123,
      "from": "system",
      "source": "user",
      "user_id": 123,
      "contents": [
        "<unknown>"
      ],
      "status": "created",
      "agent_reaction": "<string>",
      "customer_reaction": "<string>",
      "sent_at": "2023-01-01T12:00:00Z",
      "reference": "<unknown>",
      "latest_error": {
        "id": 123,
        "message_id": 123,
        "type": "status-update",
        "original_message": "<string>",
        "created_at": "2023-01-01T12:00:00Z"
      },
      "whatsapp_campaign": {
        "id": 123,
        "name": "<string>"
      }
    },
    "last_customer_reply_from": "2023-01-01T12:00:00Z",
    "latest_note": {
      "id": 123,
      "conversation_id": 123,
      "text": "<string>",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:00:00Z"
    },
    "unread_customer_messages_count": 123,
    "reply_until": "2023-01-01T12:00:00Z",
    "reply_possible": true,
    "customer_interaction_required": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Body

application/json
​
mark_external
boolean | null

Optional flag to decide if the external service behind a message should also be instructed to mark the message as read. If not defined, the value from general settings will be used which will be true by default.

Response

200 - application/json

Success

​
data
object

A conversation between an agent and a customer. Assignable to a user to mark who is actively managing the conversation.