Skip to main content
PATCH
Patch a sync config

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The unique identifier of the sync config.

Body

application/json
enabled
boolean | null

Whether the action is syncable for the connector profile.

cadence
string | null

How often the sync fires. ISO 8601 duration (e.g. PT1H).

full_sync_after
string | null

The point after which an incremental sync falls back to a full sync. ISO 8601 duration; null clears it (only accepted while the sync config is disabled, since an enabled one requires a value), omit to leave it unchanged.

start_at
string<date-time> | null

When the sync config should next be scheduled to fire; null clears it, omit to leave it unchanged.

lookback_start
string<date> | null

The earliest record date sent to the provider on every run, full and incremental. ISO 8601 date, stored as midnight UTC. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events. null turns lookback off; omit to leave it unchanged.

Whether the action syncs automatically on every account linked to this connector profile. For an action with no required parameters it is always on: omitting it means true and false is refused. An action with required parameters cannot be auto-linked.

Response

The sync config was updated.

id
string
required

The unique identifier of the sync config.

connector_profile_id
string
required

The identifier of the connector profile this sync config belongs to.

action_id
string
required

The action this sync config governs (e.g. hris_list_employees).

enabled
boolean
required

Whether the action is currently syncable for the connector profile.

cadence
string
required

How often the sync fires. ISO 8601 duration (e.g. PT1H).

Whether the action syncs automatically on every account linked to this connector profile, including accounts linked later. Forced to true whenever a write leaves an action with no required parameters enabled; a config that is disabled, or not written since, may still read false.

created_at
string<date-time>
required

When the sync config was created.

updated_at
string<date-time>
required

When the sync config was last updated.

full_sync_after
string | null

The point after which an incremental sync falls back to a full sync. ISO 8601 duration; null when unset.

start_at
string<date-time> | null

When the sync config was first scheduled to fire; null when unset.

lookback_start
string<date> | null

The earliest record date sent to the provider on every run. ISO 8601 date; null when lookback is off.