Skip to main content
POST
/
conversations
/
{conversation_id}
/
read
Read conversation
curl --request POST \
  --url https://api.partoo.co/v2/conversations/{conversation_id}/read \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '{
  "is_read": true
}'
{
  "status": "success"
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
conversation_id
integer
required

The id of the conversation to update

Body

application/json

Request body to mark a Conversation as read

​
is_read
boolean

Whether the last message received was read.
This property is scoped to the user who performs the request.
Multiple users can have a different "is_read" status for the same conversation.

Response

OK

​
status
enum<string>
Available options:
success