Inbox API

The /v1/inbox endpoints give you programmatic access to the unified inbox: list inbound comments and DMs, reply to them, and edit replies you've already sent.

Requires authentication.

---

List inbox items

GET /api/v1/inbox

Query parameters

Parameter	Type	Default	Description
status	string	—	unread, read, replied
sourceType	string	—	Filter by inbound source type
platform	string	—	Filter by platform (e.g. instagram)
accountId	string	—	Filter by account
limit	integer	25	Page size
offset	integer	0	Skip count

Example

curl "https://<your-api-origin>/api/v1/inbox?status=unread&platform=instagram&limit=20" \
  -H "Authorization: Bearer sx_live_YOUR_API_KEY"

Response — 200 OK

{
  "data": {
    "items": [
      {
        "id": "inb_01",
        "platform": "instagram",
        "sourceType": "comment",
        "accountId": "acc_abc123",
        "status": "unread",
        "message": "When does this ship?",
        "createdAt": "2026-07-12T10:00:00.000Z"
      }
    ],
    "total": 7
  }
}

---

Reply to an inbox item

POST /api/v1/inbox/{itemId}/reply

Sends a reply to the inbound comment or DM through the platform.

Request body

Field	Type	Required	Description
message	string	yes	The reply text

Example

curl -X POST https://<your-api-origin>/api/v1/inbox/inb_01/reply \
  -H "Authorization: Bearer sx_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "message": "It ships today! 🚀" }'

Response — 200 OK

{ "data": { "success": true } }

Successful replies also fire the outbound message.sent webhook; failures fire message.failed.

---

Edit a sent reply

PATCH /api/v1/inbox/{itemId}/replies/{replyId}

Edits the text of a reply you already sent.

Request body

Field	Type	Required	Description
message	string	yes	The new reply text

Response — 200 OK

{ "data": { "success": true } }

warning

Edit support is platform-dependent. Facebook supports editing sent comments; most other platforms don't expose an edit API — requests against unsupported platforms fail with a platform error.

Related

• Unified inbox — the user-facing counterpart.
• Comment automation — automated replies.
• Webhooks — message.sent, message.failed, message.delivered, message.read events.