Chats
post /api/http/chats/channels
Required permissions: Add new channels
|
post /api/http/chats/channels/dm
warning
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
|
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.
|
post /api/http/chats/channels/{channel}/restore-archived
Restore an archived channel and allow new messages to be added again.
Required permissions: Manage channels
|
get /api/http/chats/channels/all-channels
Required permissions: View channel info
|
get /api/http/chats/channels/{channel}
Required permissions: View channel info
|
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
|
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
|
post /api/http/chats/channels/conversations
Required permissions: Start new conversations
|
post /api/http/chats/channels/conversations/{channel}/convert
Required permissions: Manage channels
|
patch /api/http/chats/channels/conversations/{channel}/subject
Required permissions: Update channel info
|
get /api/http/chats/channels/{channel}/administrator
Required permissions: View channel participants
|
patch /api/http/chats/channels/{channel}/administrator
Required permissions: Manage channels
|
get /api/http/chats/channels/{channel}/attachments
Required permissions: View messages
|
get /api/http/chats/channels/{channel}/attachments/files
Required permissions: View messages
|
get /api/http/chats/channels/{channel}/attachments/images
Required permissions: View messages
|
get /api/http/chats/channels/{channel}/attachments/links
Required permissions: View messages
|
get /api/http/chats/channels/{channel}/attachments/videos
Required permissions: View messages
|
patch /api/http/chats/channels/{channel}/description
Required permissions: Update channel info
|
patch /api/http/chats/channels/{channel}/icon
Required permissions: Update channel info
|
patch /api/http/chats/channels/{channel}/name
Required permissions: Manage channels
|
post /api/http/chats/channels/{channel}/subscribers/teams
Required permissions: Add members or teams to participant list
|
get /api/http/chats/channels/{channel}/subscribers/teams
Required permissions: View channel participants
|
delete /api/http/chats/channels/{channel}/subscribers/teams
Required permissions: Remove members or teams from participant list
|
post /api/http/chats/channels/{channel}/subscribers/users
Required permissions: Add members or teams to participant list
|
get /api/http/chats/channels/{channel}/subscribers/users
Required permissions: View channel participants
|
delete /api/http/chats/channels/{channel}/subscribers/users
Required permissions: Remove members or teams from participant list
|
post /api/http/chats/messages/delete-message
Delete a message from a channel.
Required permissions: Post messages
, Post messages in threads
|
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
|
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
|
post /api/http/chats/messages/send
warning
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
|
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
|
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
|
get /api/http/chats/messages/{message}
Required permissions: View messages
|
patch /api/http/chats/messages/pin
Required permissions: Pin or unpin messages
|
patch /api/http/chats/messages/unpin
Required permissions: Pin or unpin messages
|
get /api/http/chats/messages/pinned-messages
Required permissions: View messages
|
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
|
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
|
Thanks for your feedback!