> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cessy.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cessy.ai/_mcp/server.

# Mark a channel read for the authenticated user

POST https://cessy.ai/api/rest/tenant-id/app-id/channels/{channelId}/read
Content-Type: application/json

Reference: https://docs.cessy.ai/runtime-api-template/user-channel-views/mark-channel-read

## Authentication

- `Authorization` header (bearer token, required) — OAuth/JWT bearer with the 'runtime' scope that resolves to a user principal. API keys and agent service tokens are rejected by user-delegated operations.

## Request

### Path parameters

- `channelId` (string, required) — Channel id.

### Query parameters

- `agentId` (string, optional) — Optional agent participant id filter within this app.
- `workspaceId` (string, optional) — Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

### Headers

- `X-CES-Workspace-ID` (string, optional) — Optional Workspace runtime selector header. If supplied with workspaceId, both values must match.

### Body (application/json)

This endpoint expects a MarkChannelReadRequest.

- `messageId` (string, required)

## Response

### 200

Read cursor advanced

- `read` (boolean, required)
- `readThroughMessageId` (string, required)
- `readThroughMessageTimestamp` (string, required)

## Errors

### 400 Bad Request Error

Invalid request body

- `error` (string, required)
- `message` (string, optional) — Operator-safe failure text when the endpoint exposes a typed error.
- `details` (any, optional)
- `code` (string, optional) — Stable machine-readable failure category when available.
- `executionId` (string, optional) — Protected execution-log lookup identifier when execution started.
- `correlationId` (string, optional) — Identifier for related requests and diagnostics when available.
- `effectState` (enum, optional) — Authoritative confirmation that the command effect is absent.
  - Allowed values: `rejected`, `rolled_back`

### 401 Unauthorized Error

Missing or invalid user bearer token

- `error` (string, required)
- `message` (string, optional) — Operator-safe failure text when the endpoint exposes a typed error.
- `details` (any, optional)
- `code` (string, optional) — Stable machine-readable failure category when available.
- `executionId` (string, optional) — Protected execution-log lookup identifier when execution started.
- `correlationId` (string, optional) — Identifier for related requests and diagnostics when available.
- `effectState` (enum, optional) — Authoritative confirmation that the command effect is absent.
  - Allowed values: `rejected`, `rolled_back`

### 403 Forbidden Error

The user cannot update this channel view

- `error` (string, required)
- `message` (string, optional) — Operator-safe failure text when the endpoint exposes a typed error.
- `details` (any, optional)
- `code` (string, optional) — Stable machine-readable failure category when available.
- `executionId` (string, optional) — Protected execution-log lookup identifier when execution started.
- `correlationId` (string, optional) — Identifier for related requests and diagnostics when available.
- `effectState` (enum, optional) — Authoritative confirmation that the command effect is absent.
  - Allowed values: `rejected`, `rolled_back`

### 404 Not Found Error

Channel or message not found

- `error` (string, required)
- `message` (string, optional) — Operator-safe failure text when the endpoint exposes a typed error.
- `details` (any, optional)
- `code` (string, optional) — Stable machine-readable failure category when available.
- `executionId` (string, optional) — Protected execution-log lookup identifier when execution started.
- `correlationId` (string, optional) — Identifier for related requests and diagnostics when available.
- `effectState` (enum, optional) — Authoritative confirmation that the command effect is absent.
  - Allowed values: `rejected`, `rolled_back`

### 409 Conflict Error

Read cursor command conflict

- `error` (string, required)
- `message` (string, optional) — Operator-safe failure text when the endpoint exposes a typed error.
- `details` (any, optional)
- `code` (string, optional) — Stable machine-readable failure category when available.
- `executionId` (string, optional) — Protected execution-log lookup identifier when execution started.
- `correlationId` (string, optional) — Identifier for related requests and diagnostics when available.
- `effectState` (enum, optional) — Authoritative confirmation that the command effect is absent.
  - Allowed values: `rejected`, `rolled_back`

## Examples

**Request**

```json
{
  "messageId": "msg_7f3a2b1c4e8d9f0a"
}
```

**Response**

```json
{
  "read": true,
  "readThroughMessageId": "msg_7f3a2b1c4e8d9f0a",
  "readThroughMessageTimestamp": "2024-06-12T10:45:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read"

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

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

print(response.json())
```

```javascript
const url = 'https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"messageId":"msg_7f3a2b1c4e8d9f0a"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read"

	payload := strings.NewReader("{\n  \"messageId\": \"msg_7f3a2b1c4e8d9f0a\"\n}")

	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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/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 = "{\n  \"messageId\": \"msg_7f3a2b1c4e8d9f0a\"\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messageId\": \"msg_7f3a2b1c4e8d9f0a\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read', [
  'body' => '{
  "messageId": "msg_7f3a2b1c4e8d9f0a"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"messageId\": \"msg_7f3a2b1c4e8d9f0a\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["messageId": "msg_7f3a2b1c4e8d9f0a"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId/read")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```