v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB

Chat

Send a message

This endpoint creates a top level message.

post/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages

Path parameters

workspace_idinteger required

The ID of the Workspace.

channel_idstring required

The ID of the Channel where the messages live.

Request body

assigneestring

The possible assignee of the message.

group_assigneestring

The possible group assignee of the message.

triaged_action1 | 2

The triaged action applied to the message.

triaged_object_idstring

The message triaged action object id.

triaged_object_typenumber

The message triaged action object type.

type'message' | 'post' required

The type of message.

contentstring RichText required

The full content of the message to be created. Note: Some code examples may display additional backslashes.

followersstring[]

The ids of the followers of the message

content_format'text/md' | 'text/plain'

The format of the Chat Message content (Default: text/md)

Response

The message is created.

assigneestring

The possible assignee of the message.

assigned_bystring

The user who assigned the message.

contentstring RichText required

The full content of the message.

datenumber required

The date & time the message was created (Unix epoch milliseconds timestamp).

date_assignednumber

The date & time the message was assigned (Unix epoch milliseconds timestamp).

date_resolvednumber

The date & time the message was resolved (Unix epoch milliseconds timestamp).

date_updatednumber

The date & time the message was updated (Unix epoch milliseconds timestamp).

group_assigneestring

The possible group assignee of the message.

idstring required

The ID of the message.

parent_channelstring required

The ID of the chat this message belongs to.

parent_messagestring

The ID of the message this message is a reply to.

resolvedboolean required

The resolved status of the message.

resolved_bystring

The user who resolved the message.

triaged_action1 | 2

The triaged action applied to the message.

triaged_object_idstring

The message triaged action object id.

triaged_object_typenumber

The message triaged action object type.

type'message' | 'post' required

The type of message.

user_idstring required

The ID of the user who created the message.

replies_countnumber required

The number of replies to the message.