Skip to content
Download Beeper

Messages

Manage messages in chats

Search messages
GET/v1/messages/search
List messages
GET/v1/chats/{chatID}/messages
Send a message
POST/v1/chats/{chatID}/messages
Retrieve a message
GET/v1/chats/{chatID}/messages/{messageID}
Edit a message
PUT/v1/chats/{chatID}/messages/{messageID}
Delete a message
DELETE/v1/chats/{chatID}/messages/{messageID}
ModelsExpand Collapse
MessageSendResponse object { chatID, pendingMessageID }
chatID: string

Chat ID. Input routes also accept the local chat ID from this installation when available.

pendingMessageID: string

Pending ID assigned to the message before the network confirms the send. Pass it to GET /v1/chats/{chatID}/messages/{messageID} to resolve, or wait for the matching message.upserted over the WebSocket.

MessageUpdateResponse = Message { id, accountID, chatID, 18 more }
DeprecatedmessageID: string
Use id instead.

DEPRECATED - use id instead. Compatibility alias for older clients.

Deprecatedsuccess: true
Use the HTTP 200 response status instead.

DEPRECATED - compatibility field. Successful responses are already represented by the 200 status code.