Acknowledge observed conversation messages
POST
/v1/channels/{channelId}/readRequires threads:read and an active organization membership. Sequence cannot exceed the latest conversation message. Read positions never decrease.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| channelId | path | string | Yes | — |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| sequence | integer | Yes | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Channel operation resultapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| readSequence | integer | Yes | — |
400Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
401Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
403Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
404Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
409Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
500Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
503Invalid input (400), unauthenticated (401), denied (403), unavailable resource (404), stale revision/idempotency conflict/archived channel (409), unavailable PostgreSQL backend (503), or failed operation (500).application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
Acknowledge observed conversation messages
Loading...
Response 200
Loading...