Skip to main content
POST
Create 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.

Body

application/json
connector_profile_id
string
required

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

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

action_id
string
required

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

cadence
string
required

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

enabled
boolean | null
default:true

Whether the action is syncable for the connector profile.

full_sync_after
string | null

The point after which an incremental sync falls back to a full sync. ISO 8601 duration. Required whenever enabled is true; may be omitted (or null) only on a sync config created disabled.

start_at
string<date-time> | null

When the sync config should first be scheduled to fire.

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 created.

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. 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.

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.