Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Conversations

Update an automated message

put/conversations/pushedMessages/{id}

Path parameters

idstring required

ID of the message

Request body

textstring required

edited message text

Example request

{
  "text": "Your order has shipped! Here’s your tracking number: 9114 5847 4668 7775 9233 54"
}

Response

Updated message is returned as a response

idstring

Message ID. It can be used for further manipulations with the message.

type'agent' | 'visitor'

"agent" for agents’ messages, "visitor" for visitors’ messages.

textstring

Message text or name of the attached file

visitorIdstring

visitor’s ID

agentIdstring

ID of the agent on whose behalf the message was sent (only in messages sent by an agent).

agentNamestring

Agent’s name as displayed to the visitor. Only in the messages sent by an agent.

createdAtinteger

Timestamp in milliseconds.

isPushedboolean

true for pushed messages

receivedFromstring

In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.

Example response

{
  "createdAt": 1470222622433,
  "isPushed": true,
  "agentId": "d9nKoegKSjmCtyK78",
  "file": {
    "isImage": true,
    "filename": "conversations.png",
    "size": 15538,
    "imageInfo": {
      "previewUrl": "https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/",
      "width": 1129,
      "height": 525
    },
    "url": "https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/"
  },
  "receivedFrom": "SuperAwesomeHelpdesk",
  "agentName": "Liz",
  "id": "eYBEm3gq3zc5ayE2g",
  "text": "Good morning! How can I help you?",
  "type": "agent",
  "visitorId": "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg"
}