Team Channel Users
Overview
Using the Team Channel Users endpoint you are able to add and remove individual users from a channel. If you wish to set the entire list of users for a channel use the Team Channels endpoint.
Get Channel Users
Get all users that belong to a specified channel
GET
/channels/{channel_id}/users
GET
/channels/{channel_id}/users
Pagination
The maximum number of users that will be returned in a single request is 100. If there are more than 100 users 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.
Add a Channel User
PUT
/channels/{channel_id}/users
PUT
/channels/{channel_id}/users
Path Parameters
Body Parameters
Example Request Body
Success Response
A successful channel user add 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 user.
Error Response
If there was a problem creating the channel user you will receive a response that contains status and message properties.
Example error response:
Remove a Channel User
Remove a specified user from a specified channel
DELETE
/channels/{channel_id}/users/{user_id}
DELETE
/channels/{channel_id}/users/{user_id}
Path Parameters
Success Response
A successful channel creation 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 user.
Replace Channel Users
Use this endpoint to set a channel to include a specific set of users. Any current channel users that are not specified in your request body will be removed from the channel.
PUT
/channels/{channel_id}/users/replace
PUT
/channels/{channel_id}/users/replace
Path Parameters
Body Parameters
Example Request Body
Success Response
A successful channel user replace 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.
Error Response
If there was a problem replacing the channel users you will receive a response that contains status and message properties.
Example error response:
Last updated