Patch a sync config
Updates a sync config’s mutable fields. connector_profile_id and action_id cannot be changed.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The unique identifier of the sync config.
Body
Whether the action is syncable for the connector profile.
How often the sync fires. ISO 8601 duration (e.g. PT1H).
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.
When the sync config should next be scheduled to fire; null clears it, omit to leave it unchanged.
Whether the action syncs automatically on every account linked to this connector profile. Turning it on creates a schedule for the accounts already linked as well as any linked later; turning it off pauses those schedules rather than deleting them. Hand-authored schedules are unaffected. Only allowed for actions with no required parameters.
Response
The sync config was updated.
The unique identifier of the sync config.
The identifier of the connector profile this sync config belongs to.
The action this sync config governs (e.g. hris_list_employees).
Whether the action is currently syncable for the connector profile.
How often the sync fires. ISO 8601 duration (e.g. PT1H).
Whether the action syncs automatically on every account linked to this connector profile. Turning it on creates a schedule for the accounts already linked as well as any linked later; turning it off pauses those schedules rather than deleting them. Hand-authored schedules are unaffected.
When the sync config was created.
When the sync config was last updated.
The point after which an incremental sync falls back to a full sync. ISO 8601 duration; null when unset.
When the sync config was first scheduled to fire; null when unset.