Chats Add new channel post /api/http/chats/channels
Rights, that may be checked: Add new channels
Request arguments
object with fields :
name
: string
description
: string
private
: boolean
Get or create direct messages channel post /api/http/chats/channels/dm
Deprecated since 2021-12-13: Use POST chats/channels/{channel}. It will be removed in a future version.
Create or get a direct messages channel with a profile
Request arguments
object with fields :
profile
: string
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
Restore archived channel post /api/http/chats/channels/{channel}/restore-archived
Restore an archived channel and allow new messages to be added again.
Rights, that may be checked: Manage channels
Request arguments
channel
: string in one of the formats
(Path)
List all channels get /api/http/chats/channels/all-channels
Rights, that may be checked: View channel info
Request arguments
query
: string
(Query)
Substring matching name or description of the channel
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
quickFilter
: AllChannelsFilter
(Query) ( Nullable and Optional , defaults to null
)
Additional options to filter channels
sortColumn
: AllChannelsSortColumn
(Query) ( Nullable and Optional , defaults to null
)
sortOrder
: ColumnSortOrder
(Query) ( Nullable and Optional , defaults to "ASC"
)
publicOnly
: boolean
(Query) ( Nullable and Optional , defaults to false
)
withArchived
: boolean
(Query) ( Nullable and Optional , defaults to true
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of AllChannelsListEntry
Get channel get /api/http/chats/channels/{channel}
Rights, that may be checked: View channel info
Request arguments
channel
: string in one of the formats
(Path)
Delete channel delete /api/http/chats/channels/{channel}
Delete a channel. No one will be able to view this channel or its threads. This action cannot be undone.
Rights, that may be checked: Manage channels
Request arguments
channel
: string in one of the formats
(Path)
Archive channel delete /api/http/chats/channels/{channel}/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.
Rights, that may be checked: Manage channels
Request arguments
channel
: string in one of the formats
(Path)
Create conversation post /api/http/chats/channels/conversations
Rights, that may be checked: Start new conversations
Request arguments
object with fields :
Convert conversation to private channel post /api/http/chats/channels/conversations/{channel}/convert
Rights, that may be checked: Manage channels
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
channelName
: string
Change conversation subject patch /api/http/chats/channels/conversations/{channel}/subject
Rights, that may be checked: Update channel info
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
subject
: string
Get channel administrator get /api/http/chats/channels/{channel}/administrator
Rights, that may be checked: View channel participants
Request arguments
channel
: string in one of the formats
(Path)
Assign channel administrator patch /api/http/chats/channels/{channel}/administrator
Rights, that may be checked: Manage channels
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
List attachments in channel get /api/http/chats/channels/{channel}/attachments
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
List file attachments in channel get /api/http/chats/channels/{channel}/attachments/files
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
List images in channel get /api/http/chats/channels/{channel}/attachments/images
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
List links in channel get /api/http/chats/channels/{channel}/attachments/links
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
List videos in channel get /api/http/chats/channels/{channel}/attachments/videos
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
Change channel description patch /api/http/chats/channels/{channel}/description
Rights, that may be checked: Update channel info
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
description
: string
Change channel icon patch /api/http/chats/channels/{channel}/icon
Rights, that may be checked: Update channel info
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
Rename channel patch /api/http/chats/channels/{channel}/name
Rights, that may be checked: Manage channels
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
name
: string
Add teams to channel post /api/http/chats/channels/{channel}/subscribers/teams
Rights, that may be checked: Add members or teams to participant list
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
List teams subscribed to channel get /api/http/chats/channels/{channel}/subscribers/teams
Rights, that may be checked: View channel participants
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
query
: string
(Query)
Response
object with fields :
Remove teams from channel delete /api/http/chats/channels/{channel}/subscribers/teams
Rights, that may be checked: Remove members or teams from participant list
Request arguments
channel
: string in one of the formats
(Path)
teams
: array of TeamIdentifier
(Query)
Add users to channel post /api/http/chats/channels/{channel}/subscribers/users
Rights, that may be checked: Add members or teams to participant list
Request arguments
channel
: string in one of the formats
(Path)
object with fields :
List users subscribed to channel get /api/http/chats/channels/{channel}/subscribers/users
Rights, that may be checked: View channel participants
Request arguments
channel
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
query
: string
(Query)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of TD_MemberProfile
Remove users from channel delete /api/http/chats/channels/{channel}/subscribers/users
Rights, that may be checked: Remove members or teams from participant list
Request arguments
channel
: string in one of the formats
(Path)
profiles
: array of ProfileIdentifier
(Query)
Delete message post /api/http/chats/messages/delete-message
Delete a message from a channel.
Rights, that may be checked: Post messages
, Post messages in threads
Request arguments
object with fields :
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.
Rights, that may be checked: Post messages
, Post messages in threads
Request arguments
object with fields :
Import messages post /api/http/chats/messages/import
This API method is intended to be used only by applications.
Rights, that may be checked: Import messages
Request arguments
object with fields :
Send text message post /api/http/chats/messages/send
Deprecated since 2020-01-17: Use POST chats/messages/send-message. It will be removed in a future version.
Rights, that may be checked: Post messages
, Post messages in threads
Request arguments
object with fields :
channel
: string
text
: string
pending
: boolean
( Optional , defaults to false
)
temporaryId
: string
( Nullable and Optional , defaults to null
)
Send message post /api/http/chats/messages/send-message
Send a message to a channel, thread, member, issue, code review, etc. Message content can be a string, or a block with one or several sections of information.
Rights, that may be checked: Post messages
, Post messages in threads
Request arguments
object with fields :
channel
: ChannelIdentifier
( Nullable and Optional , defaults to null
)
content
: ChatMessage
attachments
: array of AttachmentIn
( Nullable and Optional , defaults to null
)
unfurlLinks
: boolean
( Nullable and Optional , defaults to null
)
externalId
: string
( Nullable and Optional , defaults to null
)
resolveNames
: boolean
( Nullable and Optional , defaults to null
)
pending
: boolean
( Nullable and Optional , defaults to null
)
recipient
: MessageRecipient
( Nullable and Optional , defaults to null
)
Get channel messages get /api/http/chats/messages
Retrieve a batch of messages from a channel. Messages are divided into batches by providing sorting
, startFromDate
and batchSize
parameters. If the retrieved number of messages is less than batchSize
, there are currently no more messages to return. Return data also contains next value for startFromDate
as well as the orgLimitReached
flag indicating whether part of messages could not be retrieved because of organization plan limitation.
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Query)
sorting
: MessagesSorting
(Query)
startFromDate
: string
(format: date-time) (Query) ( Nullable and Optional , defaults to null
)
batchSize
: integer
(format: int32) (Query)
Get message get /api/http/chats/messages/{message}
Rights, that may be checked: View messages
Request arguments
message
: string in one of the formats
externalId
: string
id
: string
(Path)
channel
: string in one of the formats
(Query)
Pin message patch /api/http/chats/messages/pin
Rights, that may be checked: Pin or unpin messages
Request arguments
object with fields :
Unpin message patch /api/http/chats/messages/unpin
Rights, that may be checked: Pin or unpin messages
Request arguments
object with fields :
List pinned messages in channel get /api/http/chats/messages/pinned-messages
Rights, that may be checked: View messages
Request arguments
channel
: string in one of the formats
(Query)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelItemRecord
Last modified: 08 September 2022