Create a Message

Posts a plain text message, and optionally, a media content attachment, to a room.

The files parameter is an array, which accepts multiple values to allow for future expansion, but currently only one file may be included with the message.

You're not logged in. to run the demo.

Request Headers

Content-type application/json; charset=utf-8

Request Parameters

Name Type Description
roomId string

The room ID.

toPersonId string

The ID of the recipient when sending a private1:1 message.

toPersonEmail string

The email address of the recipient when sendinga private 1:1 message.

text string

The message, in plain text. If markdown is specifiedthis parameter may be optionally used to provide alternate text forUI clients that do not support rich text.

markdown string

The message, in markdown format.

files string[]

The public URL to a binary file to be posted intothe room. Only one file is allowed per message. Uploaded files are automaticallyconverted into a format that all Spark clients can render. For the supportedmedia types and the behavior of uploads, see the Message AttachmentsGuide.

Request Parameters

Name Type Your values
roomId string
toPersonId string
toPersonEmail string
text string
markdown string
files string[] Separate multiple values with commas

Response Codes




The request was invalid or cannot be otherwise served. An accompanying error message will explain further.


Authentication credentials were missing or incorrect.


The request is understood, but it has been refused or access is not allowed.


The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.


The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.


Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.


Something went wrong on the server.


Server is overloaded with requests. Try again later.