Change the poll interval of a pulled directory source
PATCH /v1/directories/{dir}/source: Change the poll interval of a pulled directory source.
PATCH /
Changes only sync_interval_minutes (5 to 1440) of a saved source and leaves its credentials untouched, so an OAuth-connected source (Gusto) keeps its tokens. Not found until credentials are saved.
- Scope
directories:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”dirstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”
The poll interval in minutes.sync_interval_minutesinteger Requiredmin 5 · max 1440
Responses
Section titled “Responses”- 200 OK DirectorySource
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X PATCH \ "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "sync_interval_minutes": 5}'const response = await fetch("https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "sync_interval_minutes": 5 }),});const data = await response.json();import osimport requests
response = requests.patch( "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "sync_interval_minutes": 5, },)data = response.json(){ "object": "directory_source", "directory_id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "kind": "bamboohr", "next_sync_at": "2026-01-15T09:30:00Z", "last_synced_at": "2026-01-15T09:30:00Z", "last_error": "saml_signature_invalid", "failures": 1, "sync_interval_minutes": 1, "last_result": {}, "last_skipped": [ { "external_id": "acme-123", "name": "Acme Corp", "reason": "no_id" } ]}