Conversations
Mark a conversation read
Marks a conversation as read: it sets unreadCount to 0 and lastReadAt to the current time. Call it when a user opens the thread in your inbox. It takes no request body, and calling it on a thread that is already read is harmless.
POST
/
conversations
/
{id}
/
read
cURL
curl --request POST \
--url https://api.vobiz.ai/api/v1/sms/conversations/{id}/read \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.conversations.mark_conversation_read(
id="c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
)
const options = {
method: 'POST',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/conversations/{id}/read', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "ok"
}{
"error": "missing or invalid credentials"
}{
"error": "conversation not found"
}{
"error": "internal error"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
The conversation id (UUID) to mark as read.
Response
Marked read.
Confirmation returned by actions that have no resource to return, such as marking a conversation read or creating or deleting an opt-out.
Always ok when the action succeeded.
Example:
"ok"
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.vobiz.ai/api/v1/sms/conversations/{id}/read \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.conversations.mark_conversation_read(
id="c7d1e9a3-2b4f-4a6c-8d5e-1f3a9b7c2e04",
)
const options = {
method: 'POST',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/conversations/{id}/read', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "ok"
}{
"error": "missing or invalid credentials"
}{
"error": "conversation not found"
}{
"error": "internal error"
}