Mark Conversation Read

warning

Inbox management is not available on the Basic plan. Upgrade to Intermediate, Growth or Business plan to access this endpoint.

Overview

The Mark Conversation Read endpoint marks unread incoming messages in a conversation as read in your inbox. Matching duplicate conversation IDs for the same participant are updated together, just as they are in Social Inbox. It returns the number of messages updated without sending a platform read receipt.

Base URL:

https://message.oneupapp.io

Endpoint

POST /api/conversations/{id}/read

Request Parameters

Parameter	Required	Type	Description
apiKey	Yes	string	Your personal API key generated from the API Access page. Passed as a query parameter.
id	Yes	integer	The conversation ID returned by Fetch Conversations. Passed in the URL path. Use id, not conversation_id.

Sample Request

curl --location --request POST \
"https://message.oneupapp.io/api/conversations/123/read?apiKey=YOUR_API_KEY"

Sample Response

{
  "message": "OK",
  "error": false,
  "data": {
    "updated_count": 2
  },
  "meta": []
}

If the connected Facebook or Instagram account needs to be synced, the API returns 202 Accepted with Retry-After: 5. Wait at least five seconds, then repeat the request. See the account sync response.

Response Fields

Field	Description
updated_count	The number of incoming messages marked as read. Returns 0 if there are no unread messages.

Error Responses

Status	When
401	Missing or invalid apiKey.
403	Inbox management is unavailable on the Basic plan.
404	The requested resource was not found or does not belong to the authorized user.
422	Invalid or missing parameters.
429	The limit of 60 requests per minute per API key was exceeded. Wait for the Retry-After interval.
503	API key verification or account sync is temporarily unavailable.

✅ Result: You have successfully marked the conversation as read!