API referenceMessages

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

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

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

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

id*string

Conversation id

messageId*string

Message id (Postgale or platform id)

Request Body

application/json
  1. body
text?string
Lengthlength <= 4096
message?string

Alias of text (Zernio)

replyMarkup?

Telegram: a new {inline_keyboard} for the message (text is then optional)

Response Body

{message}

application/json
  1. response
message?
Example Request
curl -X PATCH 'https://example.com/api/v1/inbox/conversations/string/messages/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "message": {    "id": "string",    "conversationId": "string",    "platformMessageId": "string",    "direction": "inbound",    "type": "text",    "text": "string",    "attachments": [      {        "type": "string",        "url": "string"      }    ],    "postback": {      "title": "string",      "payload": "string"    },    "reactions": [      {        "emoji": "string",        "by": "participant"      }    ],    "replyToMid": "string",    "isEcho": true,    "isDeleted": true,    "status": "received",    "tag": "HUMAN_AGENT",    "sentAt": "2019-08-24T14:15:22Z",    "deliveredAt": "2019-08-24T14:15:22Z",    "readAt": "2019-08-24T14:15:22Z",    "source": "webhook",    "content": null,    "pricing": null,    "error": "string",    "failedAt": "2019-08-24T14:15:22Z"  }}

GET /inbox/conversations/search GET

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

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

Delete a message on the platform where supported (else 400 not_supported); the stored copy is kept with isDeleted. Queued for approval (202) while approval applies