Developer API

Chats API

API is ideal for building collaborative or real-time messaging platforms with rich interaction capabilities.

The Chats API is currently in a closed beta phase and not publicly available.

Access is limited to selected partners for testing and feedback purposes.

The Chats API offers a comprehensive set of endpoints designed to manage conversations and user interactions within a chat environment.

It supports key features:

  1. Chat Management: Create, retrieve, and manage chat messages.

  2. Reaction Management: Add, view, and track emoji or custom reactions on messages.

  3. Pinning Management: Pin important messages.

For real time events, look at Real Time Events

Notable limitations in beta phase:

  • Chat message length is capped to 280 characters.

  • Reactions are limited to [:thumbs_up:,:thumbs_down:]

  • Paged chat result can return a maximum of 20 messages in a single page.

  • Destructive actions can only performed by the owner of the resource or privileged users in a session, as of now, it is only the Host of the session.

  • Pinning a message can only be done by privileged users in a session, as of now, it is only the Host of the session.

Chat Management

Retrieve paginated list of chat messages

get

Fetches a list of chat messages in a paginated format. Supports sorting by creation time, pinned status, or specific reaction types.

Authorizations
Query parameters
Skipinteger · int32Optional

The number of items to skip before starting to return results. Useful for paginating through results.

Default: 0Example: 10
Takeinteger · int32 · min: 1 · max: 20Optional

The number of items to return. Used for paginating results. Limits the size of the result set.

Default: 20Example: 20
SortBystring · enumOptional

The field by which to sort the results. Supported values include 'CreatedAt', 'Pinned', and reaction types like ':thumbsup:' or ':thumbsdown:'.

Default: CreatedAtExample: PinnedPossible values:
AscendingbooleanOptional

Determines whether the sorting should be in ascending order. Set to 'false' for descending order.

Default: trueExample: false
Responses
200
Success
get
GET /v1/chats HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

{
  "totalCount": 1,
  "messages": [
    {
      "chatId": "text",
      "message": "text",
      "createdAt": "2025-06-26T08:48:07.130Z",
      "user": {
        "id": "text",
        "name": "text"
      },
      "pinned": {
        "id": "text"
      },
      "reactions": [
        {
          "name": "text",
          "count": 1,
          "users": [
            {
              "id": "text"
            }
          ]
        }
      ]
    }
  ]
}

Send a new chat message

post

Creates and stores a new chat message within a session. This is typically used when a user sends a message in a conversation.

Authorizations
Body
messagestring | nullableOptional
Responses
200
Success
post
POST /v1/chats HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}
200

Success

{
  "chatId": "text",
  "message": "text",
  "createdAt": "2025-06-26T08:48:07.130Z"
}

Delete a specific chat message

delete

Deletes a chat message by its unique identifier.

Authorizations
Path parameters
chatIdstringRequired
Responses
200
Success
delete
DELETE /v1/chats/{chatId} HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add a reaction to a chat message

post

Adds a reaction (e.g., emoji in shortcodes format) to a specific chat message identified by its chatId.

Authorizations
Path parameters
chatIdstringRequired
Body
reactionstring | nullableOptional
Responses
200
Success
post
POST /v1/chats/{chatId}/reactions HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "reaction": "text"
}
{
  "reactionId": "text"
}

Reactions Management

Fetch reactions for multiple messages

get

Retrieves a list of reactions associated with multiple chat messages using their chat IDs.

Authorizations
Query parameters
chatIdstring[]Optional
Responses
200
Success
get
GET /v1/chats/reactions HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

[
  {
    "chatId": "text",
    "id": "text",
    "reaction": "text"
  }
]

Remove a reaction from a chat message

delete

Removes a specific reaction from a chat message. Requires both the chatId and reactionId.

Authorizations
Path parameters
chatIdstringRequired
reactionIdstringRequired
Responses
200
Success
delete
DELETE /v1/chats/{chatId}/reactions/{reactionId} HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

No content

Pinning Management

Pin a chat message

post

Pins a specific message in a chat.

Authorizations
Path parameters
chatIdstringRequired
Responses
200
Success
post
POST /v1/chats/{chatId}/pins HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unpin a chat message

delete

Removes a previously pinned message in a chat, using the chatId and pinId.

Authorizations
Path parameters
chatIdstringRequired
pinIdstringRequired
Responses
200
Success
delete
DELETE /v1/chats/{chatId}/pins/{pinId} HTTP/1.1
Host: api.quicksync.me
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Success

No content
PreviousUpload APINextWallet Verification API

Last updated