Sign in
discovery-schedules

Update a discovery schedule

Partially update a discovery schedule target.

Use this schedule operation for recurring research targets. Schedules define what Atlas should revisit; review, source freshness, and publication decisions still happen through discovery runs and workspace workflows.

patch/api/discovery-schedules/{schedule_id}

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/discovery-schedules/{schedule_id}
  • Auth: none declared

Path parameters

schedule_idstring required

Headers

x-api-keystring nullable

Request body

enabledboolean nullable

Whether this schedule is active

issue_areasstring[] nullable

Issue area slugs to discover

location_querystring nullable

Location query (e.g. 'Austin, TX')

search_depth'standard' | 'deep' nullable

Search depth for query generation

statestring nullable

2-letter state code

Response

Successful Response

created_atstring required

Creation timestamp

enabledboolean required

Whether this schedule is active

idstring required

Schedule ID

issue_areasstring[] required

Issue area slugs

last_run_atstring nullable

Timestamp of the most recent run

last_run_idstring nullable

ID of the most recent run

location_querystring required

Location query

search_depthstring required

Search depth (standard or deep)

statestring required

2-letter state code

updated_atstring required

Last update timestamp

Changes