---
title: "Set a website refresh schedule"
method: PUT
path: "/integrations/web_crawler/schedule"
tags: ["Integrations"]
---

# Set a website refresh schedule

`PUT /integrations/web_crawler/schedule`

## Request

- Base URL: `https://api.hyperspell.com`
- URL: `https://api.hyperspell.com/integrations/web_crawler/schedule`
- Auth: HTTP bearer

## Headers

- `X-As-User` string, nullable: Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

## Request body

- WebsiteScheduleParams
  - `url` string, required
  - `frequency` 'never' | 'daily' | 'weekly', nullable
  - `cron` string, nullable: Five-field cron expression: minute hour day-of-month month day-of-week. Omitted keeps the saved expression; a new website refreshes daily at 09:00.
  - `timezone` string, nullable
  - `enabled` boolean
  - `share` 'personal' | 'shared', nullable
  - `max_depth` integer, nullable
  - `limit` integer, nullable

## Response `200`

Successful Response

- WebsiteScheduleInfo
  - `url` string, required
  - `frequency` 'never' | 'daily' | 'weekly', nullable
  - `configured` boolean
  - `enabled` boolean
  - `cron` string, nullable
  - `timezone` string
  - `max_depth` integer
  - `limit` integer
  - `next_run` string, date-time, nullable
  - `schedule_missing` boolean
  - `share` 'personal' | 'shared'

## Other responses

- `422`: Validation Error

## Changes

> 43 revisions in range; 2 not diffed.

- **2026-10-22** `cdf64d80b832`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hyperspell/apis/hyperspell-api/changes/integrations/web_crawler/schedule/put.md)

---

[API](https://skmtc.dev/hyperspell/apis/hyperspell-api.md) - [All operations](https://skmtc.dev/hyperspell/apis/hyperspell-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hyperspell/apis/hyperspell-api/revisions/9bafd1215a0f?raw)