Set the check schedule

PUT

/api/did-monitoring/v1/schedule

Sets when CallerAPI checks your numbers. Send only the fields that you want to change. The other fields keep their saved values.

For a fixed interval, send interval_minutes. The values are 15, 30, 60, 120, 180, 240, 360, 480, 720, and 1440. For set times of day, set mode to times and send 1 to 24 times in times.

The response contains a credit estimate for one month. If the estimate is more than the credits that your plan includes, CallerAPI saves the schedule as paused. Then state is paused and estimate.over_plan is true.

Set enabled to false to stop scheduled checks.

INFO

This request does not use credits. Each scheduled check uses 1 credit.

Request

Authorization

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad request

🟠401Unauthorized

🟠404Not found

🟠429Too many requests

🔴503Service unavailable

Request Example

Shell

JavaScript

Java

Swift

cURL

One check a dayOne check an hourTwo set times on workdaysStop scheduled checks

curl --location --request PUT 'https://api.callerapi.com/api/did-monitoring/v1/schedule?list_id=' \
--header 'Content-Type: application/json' \
--data '{
    "enabled": true,
    "interval_minutes": 1440,
    "timezone": "UTC"
}'

Response Example

200 - Daily schedule

{
    "status": "success",
    "data": {
        "state": "scheduled",
        "summary": "Every 24 hours",
        "next_check_at": "2026-10-30T00:00:00Z",
        "enabled": true,
        "interval_minutes": 1440,
        "timezone": "UTC",
        "estimate": {
            "numbers": 1,
            "credits_per_month": 31,
            "included_credits": 5000,
            "over_plan": false
        }
    }
}

Modified at 2026-10-29 10:41:34

Read the check schedule

Save the webhook URL