API Reference

Partially update Scheduled risk check

patch
https://{defaultHost}/api/v4/numbers/risk_checks/scheduled_reports/

Partially updates a Scheduled risk check created through the API. Only provided fields are updated; phone_numbers replaces the whole list.

Available only if Scheduled risk check and Caller ID Risk Check API access are enabled for the contact center. Requires an API key with the numbers.risk_checks.scheduled_reports.manage scope.

Path Params
integer
required

The unique identifier of the scheduled report.

Body Params
string
length ≤ 100

The name of the scheduled report.

string
enum

How often the check runs.

Allowed:
string
^([01]\d|2[0-3]):[0-5]\d$

Time of day the check runs, as HH:MM in the contact center time zone.

phone_numbers
array of strings
length between 1 and 1000

Phone numbers to check on every run, in E.164 format with or without the leading plus sign. Spaces, dots, dashes and brackets are ignored. Replaces the current list.

phone_numbers
Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?