Skip to content
Dashboard
Theme
Theme

Change the poll interval of a pulled directory source

PATCH /v1/directories/{dir}/source: Change the poll interval of a pulled directory source.

View Markdown

PATCH /v1/directories/{dir}/source

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
  • dir string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • sync_interval_minutes integer Required

    The poll interval in minutes.

    min 5 · max 1440

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
}'
Response 200
{
"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"
}
]
}