Management APIReferenceRules

SetRuleInfo

View as Markdown

Edits the rule.

Allowed roles: Owner, Admin, Developer.

Example request: Deny all.

Authentication

AuthorizationBearer
Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

rule_idintegerRequired
The rule ID
rule_namestringOptional
The new rule name. The length must be less than 100
rule_patternstringOptional
The new rule pattern regex. The length must be less than 64 KB
rule_pattern_excludestringOptional
The new exclude pattern regex. The length must be less than 64 KB
video_conferencebooleanOptional
Whether video conference is required
bind_key_idstringOptional

The service account ID to bind to the rule. Read more in the guide

Response

Successful response
resultinteger
Returns 1 if the request has been completed successfully