Chatrooms

Cheaply poll whether the user's chatrooms have new activity.

Cheap poll endpoint for chatroom freshness. Send each local chatroom id with the last updated_at value you saw, or null on the first poll. The response echoes one result per requested room in request order, tells you whether the room is still accessible, and returns has_updates when you should fetch new messages.

post/v1/check_chatroom_updates

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/check_chatroom_updates
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

usernamestring nullable

The end-user's username.

passwordstring nullable

The end-user's password on first sign-in. After login/register, send the returned session token (JWT) here instead — the field accepts either, and reusing the token keeps raw passwords out of your storage.

Example request

{
  "chatrooms": [
    {
      "chatroom_id": "64f0c8b2f7a9b4e1c2d3a456",
      "known_updated_at": 1720000000.123
    },
    {
      "chatroom_id": "64f0c8b2f7a9b4e1c2d3a457",
      "known_updated_at": null
    }
  ]
}

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring
server_timenumber nullable

Current server timestamp, useful for client-side poll scheduling.

Changes

No recorded changes to this operation across all 2 revisions of this API.