JetBrains Space Help

Chats

Get or create direct messages channel

post /api/http/chats/channels/dm

Create or get a direct messages channel with a profile.

Request arguments
object with fields :

  • profile : string ( Required )

Response
M2ChannelRecord

Is name free

post /api/http/chats/channels/is-name-free

Check whether a channel name is available. Returns true when the channel name can be used to create a new channel, false otherwise.

Request arguments
object with fields :

  • name : string ( Required )

Response
boolean

Import message history

post /api/http/chats/channels/{channelId}/import
Request arguments
channelId : string (Path) ( Required )
object with fields :
Response
array of string

Restore archived channel

post /api/http/chats/channels/{channelId}/restore-archived

Restore an archived channel, and allow new messages to be added.

Request arguments
channelId : string (Path) ( Required )
Response
No arguments

List all channels

get /api/http/chats/channels/all-channels
Request arguments
query : string (Query) ( Required )
$skip : string (Query) ( Nullable and Optional , defaults to null )
$top : integer (format: int32) (Query) ( Nullable and Optional , defaults to 100 )
quickFilter : string (Query) ( Nullable and Optional , defaults to null )
sortColumn : string (Query) ( Nullable and Optional , defaults to null )
sortOrder : ColumnSortOrder (Query) ( Nullable and Optional , defaults to "ASC" )
Response
object with fields :

  • next : string ( Required )

  • totalCount : integer (format: int32) ( Nullable and Optional , defaults to null )

  • data : array of AllChannelsListEntry ( Required )

Delete channel

delete /api/http/chats/channels/{channelId}

Delete a channel. No one will be able to view this channel or its threads. This action cannot be undone.

Request arguments
channelId : string (Path) ( Required )
Response
No arguments

Archive channel

delete /api/http/chats/channels/{channelId}/archive

Archive a channel, and reject new messages being added. It is still possible to view messages from an archived channel. It is possible to restore the channel later.

Request arguments
channelId : string (Path) ( Required )
Response
No arguments

Send text message

post /api/http/chats/channels/{channelId}/messages

Send a message to a channel. Message text is a string.

Request arguments
channelId : string (Path) ( Required )
object with fields :

  • text : string ( Required )

  • temporaryId : string ( Nullable and Optional , defaults to null )

Response
ChannelItemRecord

Delete message

post /api/http/chats/messages/delete-message

Delete a message from a channel.

Request arguments
object with fields :
Response
No arguments

Edit message

post /api/http/chats/messages/edit-message

Edit an existing message. Message content can be a string, or a block with one or several sections of information.

Request arguments
object with fields :

  • channel : string ( Required )

  • message : ChatMessageIdentifier ( Required )

  • content : ChatMessage ( Required )

  • unfurlLinks : boolean ( Nullable and Optional , defaults to null )

Response
No arguments

Edit text message

post /api/http/chats/messages/edit-text-message
Request arguments
object with fields :

  • channelId : string ( Required )

  • text : string ( Required )

  • messageId : string ( Required )

Response
No arguments

Send text message

post /api/http/chats/messages/send
Request arguments
object with fields :

  • channel : string ( Required )

  • text : string ( Required )

  • pending : boolean ( Optional , defaults to false )

  • temporaryId : string ( Nullable and Optional , defaults to null )

Response
ChannelItemRecord

Send message

post /api/http/chats/messages/send-message

Send a message to a recipient, such as a channel, member, issue, code review, ... Message content can be a string, or a block with one or several sections of information.

Request arguments
object with fields :

  • recipient : MessageRecipient ( Required )

  • content : ChatMessage ( Required )

  • unfurlLinks : boolean ( Nullable and Optional , defaults to null )

  • attachments : array of AttachmentIn ( Nullable and Optional , defaults to null )

  • externalId : string ( Nullable and Optional , defaults to null )

Response
ChannelItemRecord
Last modified: 18 November 2020
Calendars Custom Fields