Zernio
APIFor you
Zernio
APIFor you
API Reference

Messages

Conversations

List conversationsGETSearch conversationsGETCreate conversationPOSTGet conversationGETUpdate conversation statusPUTMark a conversation as readPOSTChange who answers a conversation (handover)POST

Messages

List messagesGETSend messagePOSTEdit messagePATCHDelete messageDELETEUpload media filePOSTResolve message attachmentGET

Reactions & Typing

Add reactionPOSTRemove reactionDELETESend typing indicatorPOST

Other

Accept a message requestPOSTAdd a label to a conversationPOSTCreate a conversation labelPOSTDelete conversationDELETEDelete a conversation labelDELETEList the labels on a conversationGETList the Page's conversation labelsGETRemove a label from a conversationDELETE
Dashboard
OverviewPlatformsAPI ReferenceResources
Messages

Update conversation status

Archive or activate a conversation. Requires accountId in request body.

PUT
/v1/inbox/conversations/{conversationId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

conversationId*string

Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.messages.updateInboxConversation({  path: {    conversationId: 'conversation_abc123',  },  body: {    accountId: 'account_abc123',    status: 'active',  },});console.log(data);
{  "success": true,  "data": {    "id": "string",    "accountId": "string",    "status": "active",    "platform": "string",    "updatedAt": "2019-08-24T14:15:22Z"  }}
Was this page helpful?

Get conversation

Retrieve details and metadata for a specific conversation. Requires accountId query parameter.

Mark a conversation as read

Marks all unread incoming messages in the conversation as read. For WhatsApp, this also sends read receipts (blue ticks) to the contact, EXCEPT on coexistence accounts (where the WhatsApp Business app on the customer's phone owns read state and we never override it). For iMessage, this also marks the conversation read with the contact (1:1 conversations only). Best-effort. For Instagram (Instagram Login and Facebook Login) and Facebook Messenger, this also sends a `mark_seen` read receipt to the contact, so they see the conversation as seen. Best-effort: a Meta failure never fails the request. This is the explicit, human-driven counterpart to `GET .../messages`, which is side-effect-free and does NOT mark anything read. Call this when a user actually views the conversation.

accountId*string

Account ID

status*string

Value in

  • "active"
  • "archived"