POpostproxy
Direct Messages

Edit message (Telegram only)

Edit a previously-sent outbound message on the platform. Telegram only — calling this on a non-Telegram message returns 422. Edits update both the platform-side message and the Postproxy record; external_edited_at is set and a message.edited webhook fires.

patch/api/messages/{id}

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/messages/{id}
  • Auth
    HTTP bearer

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Headers

Idempotency-Keystring

Optional idempotency key (up to 255 characters; a UUID is ideal). Retrying a successful write with the same key replays the original response (with an Idempotent-Replay: true header) instead of executing again. Stored responses are kept for 24 hours; only 2xx responses are stored.

Request body

bodystring

New text. For media messages this becomes the new caption.

reply_markupobject

New inline keyboard (or other reply_markup). Pass an empty {} to remove the existing keyboard.

Response

The updated message with external_edited_at set.

idstring

Message hashid

chat_idstring

Chat hashid

external_idstring nullable

Platform-native message ID (null while pending)

direction'inbound' | 'outbound'
bodystring nullable

Message text

status'pending' | 'published' | 'failed_waiting_for_retry' | 'failed' | 'received'

pending/published/failed_waiting_for_retry/failed for outbound, received for inbound

external_comment_idstring nullable

Set when the message was sent as a private reply to a comment

error_messagestring nullable

Last error from the platform (when failed)

platform_dataobject nullable

Raw platform webhook payload, passed through unchanged. Shape is platform- and event-specific and may change without notice — prefer the typed fields where available.

external_posted_atstring nullable

ISO 8601 timestamp from the platform

external_delivered_atstring nullable

When the platform confirmed delivery (outbound; FB & IG only)

external_read_atstring nullable

When the recipient read the message (outbound; FB & IG only)

external_edited_atstring nullable

ISO 8601 timestamp of the most recent edit; body reflects the latest edit

reply_to_external_idstring nullable

Platform message ID this message replies to (inbound replies, outbound reply_to_external_id, or a Telegram callback query's source)

reply_markupobject nullable

Telegram only — the reply_markup attached to the message

cardobject nullable

Facebook and Instagram only — the card fields (subtitle, image_url, default_action) sent alongside buttons

external_deleted_atstring nullable

When the message was deleted/unsent on the platform (treat as redacted)

is_unsupportedboolean

true when the platform marked the message as unsupported (e.g. an unprocessable voice clip)

created_atstring

ISO 8601 timestamp of record creation

templateobject nullable

WhatsApp only. The template a message was sent with — id, external_id, name, language, variables.

interactiveobject nullable

WhatsApp only. Outbound: the interactive object sent. Inbound: the customer’s reply to one — type "button_reply" / "list_reply" / "nfm_reply" with the id and title you assigned.

locationobject nullable

WhatsApp only. latitude, longitude, name, address — sent or received.

sourcestring nullable

"synced" on an outbound WhatsApp message the team sent from the phone on a coexistence number.

Changes

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