Messages

Send Inbox Message

Sends a message to a conversation on Bluesky, Instagram or Facebook. Instagram and Facebook also support attachments, quick replies, buttons and carousels.

POST
/v1/inbox/messages

Authorization

headerx-api-key<token>

Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.

Request Body

application/json
  1. body
accountId*string

Connection id.

Length1 <= length
convoId*string
Length1 <= length
text*string
Length1 <= length <= 2000
attachmentUrl?string

Public HTTPS URL of an image, video, audio file or PDF to attach. Instagram and Facebook only.

Formaturi
Lengthlength <= 2048
quickReplies?array<>

Quick reply buttons shown under the message. Instagram and Facebook only.

Itemsitems <= 13
buttons?array<>

Buttons shown with the message. Instagram and Facebook only.

Itemsitems <= 3
templateElements?array<>

Cards shown as a swipeable carousel. Instagram and Facebook only.

Itemsitems <= 10

Response Body

Sent message

application/json
  1. response
accountId*string
message*
Example Request
import { Configuration, InboxApi } from "@onepostly/sdk";const inboxApi = new InboxApi(  new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await inboxApi.sendInboxMessage({  sendInboxMessageBody: {    "accountId": "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5",    "convoId": "3k7x...",    "text": "Hey, loved your latest post!"  },});console.log(response);
Example Response
{  "accountId": "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5",  "message": {    "id": "3k7y...",    "text": "Hey, loved your latest post!",    "senderId": "did:plc:alice",    "sentAt": "2026-09-08T12:00:00.000Z",    "attachments": [      {        "type": "image",        "url": "https://cdn.example.com/photo.jpg"      }    ]  }}