Mark conversation as read

Mark a conversation as read, clearing its unread indicator without sending a message. Returns the updated conversation.

POST /v1/conversations/{conversationId}/mark-as-read

Mark conversation as read

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/v1/conversations/{conversationId}/mark-as-read \
  --header 'Authorization: <api-key>'

200

{
  "assignedTo": "US123abc",
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "id": "CN123abc",
  "lastActivityAt": "2023-11-07T05:31:56Z",
  "lastActivityId": "AC123abc",
  "mutedUntil": "2023-11-07T05:31:56Z",
  "name": "Chat with customer",
  "participants": [
    "[phone]"
  ],
  "phoneNumberId": "PN123abc",
  "snoozedUntil": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Path Parameters

conversationId · string · required

The unique identifier of the conversation to mark as read.

Pattern: ^CN(.*)$

Example:

"CN123abc"

Response

200

application/json

OK

assignedTo · Option 1 · string Option 2 · string · required

The unique identifier of the user or system user the conversation is assigned to.

Pattern: ^US(.*)$

Example:

"US123abc"

createdAt · string<date-time> | null · required

deletedAt · string<date-time> | null · required

id · string · required

The unique identifier of the conversation.

Pattern: ^CN(.*)$

Example:

"CN123abc"

lastActivityAt · string<date-time> | null · required

lastActivityId · string | null · required

The unique identifier of the most recent activity in the conversation.

Pattern: ^AC(.*)$

Example:

"AC123abc"

mutedUntil · string<date-time> | null · required

name · string | null · required

The custom name of the conversation. Will be null if no custom name is set.

Example:

"Chat with customer"

participants · string[] · required

An array of phone numbers involved in the call, excluding your Quo number. Each number is either a phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (Anonymous, Blocked, or Restricted).

A phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (Anonymous, Blocked, or Restricted).

Pattern: ^(?:\+[1-9]\d{1,14}|\d{5,6}|[aA](?:nonymous|NONYMOUS)|[bB](?:locked|LOCKED)|[rR](?:estricted|ESTRICTED))$

phoneNumberId · string · required

The unique identifier of the Quo phone number associated with the conversation.

Pattern: ^PN(.*)$

Example:

"PN123abc"

snoozedUntil · string<date-time> | null · required

updatedAt · string<date-time> | null · required