Update a boost

Update a boost's configuration. All fields are optional — only include what you want to change. Returns 409 if the boost is currently running.

PUT /v1/boosts/{id}

Requires scope: boosts:write

Path parameters

Parameter	Type	Required	Description
`id`	integer	Required	Boost ID.

Body parameters

All body parameters are optional. Only include the fields you want to update.

Parameter	Type	Description
`name`	string	Display name for the boost.
`region`	array	Target regions.
`url_root`	string	Only warm URLs starting with this path.
`exclude_ext`	array	File extensions to skip.
`variations`	object	Warming variations (user agents and languages).
`sitemap_ids`	array	IDs of sitemaps to warm.
`content_types`	array	Content types to target.
`schedule`	string\|null	Cron expression (UTC). Set to `null` to remove the schedule.
`call_limit`	integer\|null	Maximum number of calls. Set to `null` to remove the limit.
`ignore_errors`	boolean	If `true`, the boost will not auto-pause on high error rates.
`report_email_enabled`	boolean	Send an email report when a run completes.

Example request

curl -X PUT https://api.cache-boost.com/v1/boosts/15 \
  -H "Authorization: Bearer cb_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"schedule": "0 3 * * *", "region": ["fr", "eu"]}'

Response

Returns 200 OK with the updated boost object.

Errors

Code	Description
`401`	Missing or invalid API key.
`403`	Insufficient scope or access denied.
`404`	Boost not found.
`409`	Boost is currently running — cannot be updated.
`422`	Validation error — invalid field values.