Create a Channel
This endpoint creates a Rev Channel and assigns Channel Members and Roles.
POST
/api/v2/channels
Request Body
{
"name": "Development Channel 003",
"description": "Channel for sharing information with the Development Team.",
"members": [
{
"id": "ea9dd7f1-9690-4133-9f47-5c965f4b6221",
"type": "User",
"roleTypes": [
"Admin"
]
},
{
"id": "bf762e1d-4d07-40ab-a48c-4c29574da0f5",
"type": "User",
"roleTypes": [
"Contributor"
]
},
{
"id": "11027324-6885-4a9e-b899-e096d8efb01d",
"type": "User",
"roleTypes": [
"Member"
]
},
{
"id": "85a72e1b-76db-45cd-9008-8eab619d02d7",
"type": "Group",
"roleTypes": [
"Member"
]
},
{
"id": "4dbe2fea-47b6-42c8-9892-d4131024cc55",
"type": "Group",
"roleTypes": [
"Admin"
]
}
]
}
| Parameter | Type | Validations |
|---|---|---|
| name | string, required | Name for the channel. Must be unique in the Rev account. |
| description | string, optional | Channel description. |
| members [ ] | array [ channelMember ], optional | Users and Groups to add to the Channel. The role type/permissions will be specified within the channelMembers object. |
| id | string, optional | Channel Member being added id. |
| type | string, optional | Type of Channel member being added; user or group. |
| roleTypes [ ] | array [ string ], optional |
The role of the channelMember being added; This may be:
|