PostZen
Inbox

Get a direct message conversation

GET
/v1/inbox/conversations/{conversationId}

Returns one thread, refreshing PostZen’s stored copy from the platform first. Read-only and read-write API keys are accepted.

Authorization

bearerAuth
AuthorizationBearer <token>

PostZen API key.

In: header

Path Parameters

conversationId*string

The platform's own conversation (thread) id, as returned in id by the list and search endpoints — not a PostZen document id.

Query Parameters

accountId*string

PostZen account id that owns the conversation.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inbox/conversations/string?accountId=string"
{  "data": {    "id": "t_17845791234567890",    "platform": "instagram",    "accountId": "k17d8s9f0a1b2c3d4e5f6g7h8i",    "accountUsername": "postzenhq",    "participantId": "17841400000000000",    "participantName": "Jane Doe",    "participantUsername": "janedoe",    "participantPicture": "https://scontent.cdninstagram.com/v/t51.2885-19/jane.jpg",    "lastMessage": "Is the sale still on?",    "lastMessageAt": "2026-08-18T16:04:11.000Z",    "updatedTime": "2026-08-18T16:04:11.000Z",    "status": "active",    "unreadCount": 2  }}
{  "error": "Direct messages support Instagram accounts only.",  "code": "platformUnsupported",  "platform": "tiktok"}
{  "error": "Unauthorized"}
{  "error": "Reconnect the account to grant PostZen access to its messages.",  "code": "platformCapabilityMissing",  "platform": "instagram"}
{  "error": "That conversation could not be found.",  "code": "conversationNotFound"}
{  "error": "This connection needs to be reauthorized before its messages can be read.",  "code": "connectionDead"}
{  "error": "rate_limited",  "retryAfter": 30}
{  "error": "Failed to create post"}

Search direct message conversations GET

Searches the conversations PostZen has already synced — Meta exposes no message search API, so this reads PostZen's own copy and refreshes it first. Message text matches whole tokens, case- and accent-insensitively (`cafe` finds `café`, `art` does not match `start`); participant names and usernames match on substring. Setting `direction` narrows the search to message text only, so a thread that matched only on the participant's name is excluded. Read-only and read-write API keys are accepted.

Archive or unarchive a conversation PUT

Sets the thread’s status. This is PostZen-local state — Meta has no archive API, so nothing is sent to the platform and a later sync never overwrites it. Requires a read-write API key.