message

edit a message

Edit a previously sent message.

post/instances/{id}/client/action/edit-message

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/edit-message
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

The ID of the message to edit

messagestring required

The new message content

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Message edited successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "data": {
      "edited": true
    }
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.