Mark a chat as read

curl --request POST \
  --url https://api.isnap.ai/v1/chats/{chat_id}/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.isnap.ai/v1/chats/{chat_id}/read"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.isnap.ai/v1/chats/{chat_id}/read', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.isnap.ai/v1/chats/{chat_id}/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.isnap.ai/v1/chats/{chat_id}/read"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.isnap.ai/v1/chats/{chat_id}/read")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.isnap.ai/v1/chats/{chat_id}/read")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "chat_id": "<string>",
    "read_at": "<string>",
    "marked_count": 1
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

POST

chats

{chat_id}

read

Mark a chat as read

curl --request POST \
  --url https://api.isnap.ai/v1/chats/{chat_id}/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.isnap.ai/v1/chats/{chat_id}/read"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.isnap.ai/v1/chats/{chat_id}/read', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.isnap.ai/v1/chats/{chat_id}/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.isnap.ai/v1/chats/{chat_id}/read"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.isnap.ai/v1/chats/{chat_id}/read")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.isnap.ai/v1/chats/{chat_id}/read")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "chat_id": "<string>",
    "read_at": "<string>",
    "marked_count": 1
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

{
  "success": false,
  "data": "<unknown>",
  "error": {
    "status": 123,
    "code": "<string>",
    "message": "<string>",
    "retry_after": 123,
    "retry_at": "<string>",
    "issues": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "code": "<string>",
        "min": 123,
        "max": 123
      }
    ]
  },
  "trace_id": "<string>",
  "request_id": "<string>"
}

Credential: an API key. A trial key returns 401 unauthorized. See Read receipts.
Line-scoped keys: the list of a line-scoped key is not applied: such a key acts on any chat of the account.
Test keys: a call with an isnap_test_ account key acts on the real chat: see Test keys.
Idempotency-Key: not honored. A repeat marks only the inbound messages received since the previous call.
Events: sends one message.read per message marked, with chat_id and read_at.
Personal data: each message.read carries the whole message: its text, the sender’s handle and the names of its files. The call marks every inbound message of the chat that iSnap still keeps and that is not marked read, including the messages that an earlier owner of the line received: ignore the events about messages from before you got the line, see A chat is never deleted. Request this data only when needed, do not copy it into logs, tickets or other tools, and refer to a contact by an id of your own.
What reaches the contact: the line’s device marks the Messages conversation read when it supports read receipts. Otherwise nothing reaches the contact, and the call still succeeds. The status of the marked messages stays delivered.

Errors

Status	`error.code`	When
404	`not_found`	The chat is unknown, or its line is not yours.
422	`sms_read_receipt_not_supported`	The chat’s line is not an iMessage line.
422	`unsupported_handle`	The chat’s contact is not a phone number in E.164.

The errors that every operation shares are in Errors.

Authorizations

Authorization

string

header

required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

chat_id

string

required

Chat id: chat_ followed by 25 letters or digits.

Pattern: ^chat_[0-9A-Za-z]{25}$

Body

application/json

An empty object: the request takes no field.

Response

The inbound messages of the chat are marked as read.

success

enum<boolean>

required

Always true on a success response.

Available options:

true

data

object

required

The result of POST /v1/chats/{chat_id}/read.

Show child attributes

trace_id

string

required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id

string

required

Id of the request that produced this response: req_ followed by 25 letters or digits.

API reference

Messages

Chats

Attachments

Recipient lookup

Lines

Line lifecycle

Line configuration and state

Webhook subscriptions

Trials

BYOD

Pre-orders

Hosted macOS sessions

Service

Mark a chat as read

Errors

Authorizations

Path Parameters

Body

Response

​Errors

Authorizations

Path Parameters

Body

Response

Errors