Chats
Add new channel post /api/http/chats/channels
Required permissions: Add new channels
Request arguments
object with fields :
name
: string
( Required )
description
: string
( Required )
private
: boolean
( Required )
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 :
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 :
Restore archived channel post /api/http/chats/channels/{channel}/restore-archived
Restore an archived channel and allow new messages to be added again.
Required permissions: Manage channels
Request arguments
channel
: string in one of the formats
(Path) ( Required )
List all channels get /api/http/chats/channels/all-channels
Required permissions: View channel info
Request arguments
query
: string
(Query) ( Required )
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
)
subscriber
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Query) ( Nullable and Optional , defaults to null
)
Filters the resulting list by the channel subscriber.
Response
object with fields :
next
: string
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of AllChannelsListEntry
( Required )
Get channel get /api/http/chats/channels/{channel}
Required permissions: View channel info
Request arguments
channel
: string in one of the formats
(Path) ( Required )
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.
Required permissions: Manage channels
Request arguments
channel
: string in one of the formats
(Path) ( Required )
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.
Required permissions: Manage channels
Request arguments
channel
: string in one of the formats
(Path) ( Required )
Create conversation post /api/http/chats/channels/conversations
Required permissions: Start new conversations
Request arguments
object with fields :
Convert conversation to private channel post /api/http/chats/channels/conversations/{channel}/convert
Required permissions: Manage channels
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
Change conversation subject patch /api/http/chats/channels/conversations/{channel}/subject
Required permissions: Update channel info
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
Get channel administrator get /api/http/chats/channels/{channel}/administrator
Required permissions: View channel participants
Request arguments
channel
: string in one of the formats
(Path) ( Required )
Assign channel administrator patch /api/http/chats/channels/{channel}/administrator
Required permissions: Manage channels
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
List attachments in channel get /api/http/chats/channels/{channel}/attachments
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$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
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
( Required )
List file attachments in channel get /api/http/chats/channels/{channel}/attachments/files
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$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
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
( Required )
List images in channel get /api/http/chats/channels/{channel}/attachments/images
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$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
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
( Required )
List links in channel get /api/http/chats/channels/{channel}/attachments/links
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$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
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
( Required )
List videos in channel get /api/http/chats/channels/{channel}/attachments/videos
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$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
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelInfoAttachment
( Required )
Change channel description patch /api/http/chats/channels/{channel}/description
Required permissions: Update channel info
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
Change channel icon patch /api/http/chats/channels/{channel}/icon
Required permissions: Update channel info
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
Rename channel patch /api/http/chats/channels/{channel}/name
Required permissions: Manage channels
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
Add teams to channel post /api/http/chats/channels/{channel}/subscribers/teams
Required permissions: Add members or teams to participant list
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
List teams subscribed to channel get /api/http/chats/channels/{channel}/subscribers/teams
Required permissions: View channel participants
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
query
: string
(Query) ( Required )
Response
object with fields :
next
: string
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of TD_Team
( Required )
Remove teams from channel delete /api/http/chats/channels/{channel}/subscribers/teams
Required permissions: Remove members or teams from participant list
Request arguments
channel
: string in one of the formats
(Path) ( Required )
teams
: array of TeamIdentifier
(Query) ( Required )
Add users to channel post /api/http/chats/channels/{channel}/subscribers/users
Required permissions: Add members or teams to participant list
Request arguments
channel
: string in one of the formats
(Path) ( Required )
object with fields :
List users subscribed to channel get /api/http/chats/channels/{channel}/subscribers/users
Required permissions: View channel participants
Request arguments
channel
: string in one of the formats
(Path) ( Required )
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
query
: string
(Query) ( Required )
Response
object with fields :
next
: string
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of TD_MemberProfile
( Required )
Remove users from channel delete /api/http/chats/channels/{channel}/subscribers/users
Required permissions: Remove members or teams from participant list
Request arguments
channel
: string in one of the formats
(Path) ( Required )
profiles
: array of ProfileIdentifier
(Query) ( Required )
Delete message post /api/http/chats/messages/delete-message
Delete a message from a channel.
Required permissions: 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.
Required permissions: Post messages
, Post messages in threads
Request arguments
object with fields :
channel
: ChannelIdentifier
( Required )
message
: ChatMessageIdentifier
( Required )
content
: ChatMessage
( Required )
attachments
: array of AttachmentIn
( Nullable and Optional , defaults to null
)
unfurlLinks
: boolean
( Nullable and Optional , defaults to null
)
resolveNames
: boolean
( Nullable and Optional , defaults to null
)
Import messages post /api/http/chats/messages/import
This API method is intended to be used only by applications. The createdAtUtc
and editedAtUtc
parameters are Unix epoch timestamps in milliseconds .
Required permissions: Import messages
, Import issues
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.
Required permissions: Post messages
, Post messages in threads
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
)
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.
Required permissions: Post messages
, Post messages in threads
Request arguments
object with fields :
channel
: ChannelIdentifier
( Nullable and Optional , defaults to null
)
content
: ChatMessage
( Required )
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.
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Query) ( Required )
sorting
: MessagesSorting
(Query) ( Required )
startFromDate
: string
(format: date-time) (Query) ( Nullable and Optional , defaults to null
)
batchSize
: integer
(format: int32) (Query) ( Required )
Get message get /api/http/chats/messages/{message}
Required permissions: View messages
Request arguments
message
: string in one of the formats
externalId
: string
id
: string
(Path) ( Required )
channel
: string in one of the formats
(Query) ( Required )
Pin message patch /api/http/chats/messages/pin
Required permissions: Pin or unpin messages
Request arguments
object with fields :
Unpin message patch /api/http/chats/messages/unpin
Required permissions: Pin or unpin messages
Request arguments
object with fields :
List pinned messages in channel get /api/http/chats/messages/pinned-messages
Required permissions: View messages
Request arguments
channel
: string in one of the formats
(Query) ( Required )
$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
( Required )
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChannelItemRecord
( Required )
Get sync batch get /api/http/chats/messages/sync-batch
Get messages in specified channel for synchronization with third-party system. Messages with etag greater than specified value are returned, in the order of creation and updates. Use etag value " 0 " to start retrieving all messages in the channel. To get the current etag value, use " Get current sync batch etag " method. Read more in the documentation .
Required permissions: View messages
Request arguments
batchInfo
: string in one of the formats
(Query) ( Required )
channel
: string in one of the formats
(Query) ( Required )
Response
object with fields :
Get current sync etag get /api/http/chats/messages/sync-batch/current-etag
Get current sync etag for given channel. You can use the returned etag to retrieve updates starting from this point through " Get sync batch " method. To retrieve all records instead, use " 0 " as the starting etag value. Read more in the documentation .
Required permissions: View channel info
Request arguments
channel
: string in one of the formats
(Query) ( Required )
Last modified: 06 September 2023