v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Send Message

This API endpoint sends a message within a Message Channel.

post/v1/messages

Request body

textstring required

The contents of the message. Supports some formatting, see the Message resource for details.

channelIdstring required

The Message Channel where the message will be sent.

senderIdstring

The user (Client or Internal User) to send this message on behalf of. If specified, the sender must be a member of the Message Channel. If not specified, the message will be sent on behalf of the user who generated the API key used in the request.

Response

200

idstring

objectstring

senderIdstring

createdAtstring

updatedAtstring

channelIdstring

isAttachmentIncludedboolean

textstring

Example response

{
  "id": "fbd5a90b-5216-4230-bcd2-0d6a746aeb65",
  "object": "message",
  "senderId": "1dbb3e36-af70-4f41-89e6-6ddf9e2c62b5",
  "createdAt": "2023-08-07T15:11:13.549092588Z",
  "updatedAt": "2023-08-07T15:11:13.549092588Z",
  "channelId": "602f5afd-2a42-47a4-a5e0-c3db0adf966a",
  "isAttachmentIncluded": true,
  "text": "This is an **urgent** message! My favorite client portal is [Copilot](https://copilot.com)."
}