Set or remove a channel permission overwrite
Requires MANAGE_PERMISSIONS. targetID is preferred; roleID and userID are accepted aliases. To remove an overwrite, set action to DELETE or remove to true. Otherwise allow and deny default to empty arrays and replace the target's overwrite.
Request
POST http://localhost:8989/api/channels/{channelID}/permissions
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| channelID | string | Channel identifier. |
Required |
Request body
The request body takes a complete Channel Permission Request resource, containing the following writable properties:
{
"action": "string",
"allow": [
"string"
],
"deny": [
"string"
],
"remove": "boolean",
"roleID": "string",
"targetID": "string",
"userID": "string"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| action | string |
Possible values are:
|
Optional |
| allow[] | array of string |
Possible values are:
|
Optional |
| deny[] | array of string |
Possible values are:
|
Optional |
| remove | boolean | Optional | |
| roleID | string | Optional | |
| targetID | string | Optional | |
| userID | string | Optional |
Authorisation
This request requires the use of one of following authorisation methods:
API key
.
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK Overwrite updated or removed. |
Channel Permission Mutation Response |
| 400 | Bad Request The request is invalid, references a missing resource, or conflicts with existing state. |
Error Response |
| 401 | Unauthorized The Authorization header is missing or malformed. |
Error Response |
| 403 | Forbidden The token is invalid or expired, or the requester lacks a required permission. |
Error Response |
| 500 | Internal Server Error The server could not complete the operation. |
Error Response |