Skip to main content
POST
Mark a conversation unread

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Headers

Idempotency-Key
string

Optional. A unique value (8 to 64 letters, digits, - or _; a UUID is ideal) that makes a retry safe: the same key with the same request within 24 hours returns the stored response, with Idempotent-Replayed: true, instead of doing the work twice. The same key with a different request is 409 IDEMPOTENCY_KEY_REUSED; while the first request still runs it is 409 IDEMPOTENCY_IN_PROGRESS. A malformed key is 400 VALIDATION_ERROR.

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9_-]{8,64}$

Path Parameters

conversationId
string
required

The conversation id (cnv_…).

Maximum string length: 40

Response

The updated conversation.

creatorId
string
required

The creator whose inbox this conversation is in.

fan
ConversationFan · object
required

Who the creator is talking to.

id
string
required

The conversation id (cnv_…).

lastMessage
LastMessage · object | null
required

The latest message, or null for an empty conversation.

lastMessageAt
string | null
required

When the latest message was sent.

status
enum<string>
required

Who answers this chat. ai: the AI chatter. team: your team (the AI is paused on it until takenOverUntil). handoff: the AI handed it to your team and is silent until the hand-off is resolved. ai_off: the AI is switched off for this chat.

Available options:
ai,
team,
handoff,
ai_off
takenOverUntil
string | null
required

While status is team: when the chat returns to the AI on its own. Otherwise null.

totalSpentCents
integer
required

Everything this fan has spent on the creator, in cents.

unreadCount
integer
required

Fan messages not yet marked read in OnlyX.