Skip to content

Set the deduplication check schedule

PUT
/api/v1/admin/dedup/scrub/schedule
curl --request PUT \
--url https://example.com/api/v1/admin/dedup/scrub/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "day": "monday", "frequency": "weekly", "time": "example" }'

Sets the deduplication check schedule. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 400 if the request is invalid, 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/admin/dedup/scrub/schedule. Inputs: . A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Media typeapplication/json
object
day
One of:
string
Allowed values: monday tuesday wednesday thursday friday saturday sunday
frequency
required

The small schedule vocabulary exposed to the admin UI. Cron remains a server-side storage detail; this type is the editable representation.

string
Allowed values: weekly daily off
time
required
string
Media typeapplication/json
object
day
One of:
string
Allowed values: monday tuesday wednesday thursday friday saturday sunday
frequency
One of:

None means an older custom cron schedule that the simple control cannot represent yet. The UI asks the admin to choose a new value.

string
Allowed values: weekly daily off
time
string | null
timezone
required
string
Example
{
"day": "monday",
"frequency": "weekly"
}