Channel members
4 routes. Paths are relative to https://api.intersink.com/v1.
- GET/channel/{channelId}/membersList a channel's members
- POST/channel/{channelId}/membersInvite a member to a channel
- PATCH/channel/members/{memberId}Update a channel member (permission/status)
- DELETE/channel/members/{memberId}Remove a channel member, or leave the channel (your own active or suspended seat; not the owner)
List a channel's members
GET/channel/{channelId}/members
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| statusrequired | string, query | |
| qrequired | string, query | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Invite a member to a channel
POST/channel/{channelId}/members
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| emailrequired | string | Example: "member@example.com" |
| permissionrequired | string | One of: "admin", "manager", "editor", "view". Example: "manager" |
Response
201. The payload in data is not described in the spec yet.
Update a channel member (permission/status)
PATCH/channel/members/{memberId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| memberIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| permission | string | One of: "admin", "manager", "editor", "view". |
| status | string | One of: "active", "suspended". |
Response
200. The payload in data is not described in the spec yet.
Remove a channel member, or leave the channel (your own active or suspended seat; not the owner)
DELETE/channel/members/{memberId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| memberIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.