API referenceMessages

GET /inbox/conversations/search

Search conversations by participant (name, username, phone) and by message text, most recent match first. Each result carries match: {messageId, text} or {participant: true}

GET
/inbox/conversations/search

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Query Parameters

q*string

Search text

Length2 <= length <= 200
accountId?string

Only this account

platform?string

Only this platform

limit?integer

Maximum items (default 25, max 100)

Range1 <= value <= 100
Default25

Response Body

{conversations}

application/json
  1. response
conversations?array<>
Example Request
curl -X GET 'https://example.com/api/v1/inbox/conversations/search?q=string'
Example Response
{  "conversations": [    {      "id": "string",      "accountId": "string",      "platform": "instagram",      "platformConversationId": "string",      "participant": {        "id": "string",        "username": "string",        "name": "string",        "pictureUrl": "string",        "phone": "string",        "userId": "string",        "parentUserId": "string"      },      "lastMessage": {        "text": "string",        "direction": "inbound",        "at": "2019-08-24T14:15:22Z"      },      "unreadCount": 0,      "lastReadAt": "2019-08-24T14:15:22Z",      "participantReadAt": "2019-08-24T14:15:22Z",      "status": "active",      "messagingWindow": {        "open": true,        "closesAt": "2019-08-24T14:15:22Z",        "humanAgentClosesAt": "2019-08-24T14:15:22Z"      },      "syncedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

POST /inbox/conversations/{id}/sync POST

Fetch the latest messages of one conversation from Meta (needs platformConversationId from an account sync, else 409 sync_required). No customer webhooks are emitted

PATCH /inbox/conversations/{id}/messages/{messageId} PATCH

Edit a message the account sent, where the platform allows it (else 400 not_supported). messageId is the Postgale id or the platform message id. Queued for approval (202) while approval applies