Direct Message Channels
Direct message channels are typically used for ad-hoc and private communication between two or more users.
Get All DM Channels
Get information about all direct message channels.
GET
/direct_message_channels
GET
/direct_message_channels
Pagination
The maximum number of channels that will be returned in a single request is 100. If there are more than 100 channels you can specify a page
parameter great than 1 to get more data. The response will contain information about how many pages of data are available.
Query Parameters
Success Response
A successful response will have an HTTP status of 200
Response Properties
Example response
The sample response below indicates that you have received the second page of results. There are 2 pages available. The current page contains 21 of the total 121 channels.
Create Direct Message Channel
Create a new direct message channel.
POST
direct_message_channels
POST
direct_message_channels
Body Parameters
Direct Message Channels must contain at least 2 users
Example Request Body
Success Response
A successful channel creation response will have an HTTP status of 201
created
. The payload of the response is the same as you will see when requesting information about a specific channel.
Error Response
If there was a problem creating the channel you will receive a response that contains status and message properties.
Example error response:
Get Specified Direct Message Channel
Get information about a specific direct message channel
GET
/direct_message_channels/{channel_id}
GET
/direct_message_channels/{channel_id}
Path Parameters
Success Response
A successful channel creation response will have an HTTP status of 200
Response Properties
Example Response Body
Update Direct Message Channel
Update a specified direct message channel.
POST
/direct_message_channels/{channel_id}
POST
/direct_message_channels/{channel_id}
Path Parameters
Body Parameters
See Create DM Channel Body Parameters.
Success Response
A successful channel update response will have an HTTP status of 200
. The payload of the response is the same as you will see when requesting information about a specific channel.
Soft Delete Direct Message Channel
Mark a specified direct message channel as deleted.
After you delete a channel it will not actually be removed from the platform. It will be flagged for deletion and will not appear in the ĀLO app.
DELETE
/direct_message_channels/{channel_id}
DELETE
/direct_message_channels/{channel_id}
Path Parameters
Success Response
A successful channel soft delete will have an HTTP status of 200
. The body of the response will also contain information about the channel that was deleted.
Hard Delete Direct Message Channel
Delete specified direct message channel.
After you hard delete a channel it WILL BE REMOVED from the platform. The channel and related information will not be recoverable.
DELETE
/direct_message_channels/{channel_id}/hard_delete
DELETE
/direct_message_channels/{channel_id}/hard_delete
Path Parameters
Success Response
A successful channel hard delete will have an HTTP status of 200
. The body of the response will also contain information about the channel that was deleted.
Last updated