Team Channels
Overview
Team channels are typically used for permanent communication, although team channels can be created and removed on demand. In most ways Direct Message channels and Team channels are identical.
Get All Channels
Get information about all team channels.
GET
/channels
GET
/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 Channel
Create a new team channel.
POST
/channels
POST
/channels
Body Parameters
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 Channel
Get information about a specific team channel
GET
/channels/{channel_id}
GET
/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 Channel
Update a specified team channel.
POST
/channels/{channel_id}
POST
/channels/{channel_id}
Path Parameters
Body Parameters
See Create 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 Channel
Mark a specified 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
/channels/{channel_id}
DELETE
/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 Channel
Delete a specified channel.
After you hard delete a channel it WILL BE REMOVED from the platform. The channel and related information will not be recoverable.
DELETE
/channels/{channel_id}/hard_delete
DELETE
/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