Restricted Words Config

Restricted Words Config

• Restricted Words - Restricted Words Manage
  • GET global/restrictedWordsConfig - Get a single Restricted Words Config
  • POST global/restrictedWordsConfig:disable - Disable the Restricted Words Config
  • POST global/restrictedWordsConfig:enable - Enable the Restricted Words Config
  • PUT global/restrictedWordsConfig - Update the Restricted Words Config

Restricted Words Config JSON Format

Restricted Words Config is represented as simple flat JSON objects with the following keys:

Get a single Restricted Words Config

GET global/restrictedWordsConfig

• Parameters:

No Parameters

• Response:

Restricted Words Config

• Example

Sample Request:

curl https://api11.comm100.io/v4/global/restrictedWordsConfig \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "siteId": 10000,
  "isEnabled": true,
  "restrictedWords": "test"
} 

Disable the Restricted Words Config

POST global/restrictedWordsConfig:disable

• Parameters:

No Parameters

• Response:

Restricted Words Config

• Example

Sample Request:

curl https://api11.comm100.io/v4/global/restrictedWordsConfig:disable \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "siteId": 10000,
  "isEnabled": false,
  "restrictedWords": "test"
} 

Enable the Restricted Words Config

POST global/restrictedWordsConfig:enable

• Parameters:

No Parameters

• Response:

Restricted Words Config

• Example

Sample Request:

curl https://api11.comm100.io/v4/global/restrictedWordsConfig:enable \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "siteId": 10000,
  "isEnabled": true,
  "restrictedWords": "test"
} 

Update the Restricted Words Config

PUT global/restrictedWordsConfig

• Parameters:

• Response:

Restricted Words Config

• Example

Sample Request:

curl https://api11.comm100.io/v4/global/restrictedWordsConfig \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"isEnabled":true,"restrictedWords":"test"}' 

Response:

HTTP/1.1 200 OK

{
  "siteId": 10000,
  "isEnabled": true,
  "restrictedWords": "test"
}