Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

id
string
required

The contact-list id the source belongs to.

sourceId
string
required

The sync-source id (returned by createOutboundListSource / listOutboundListSources).

Body

application/json

A partial update — an omitted field is left unchanged.

enabled
boolean
syncMode
enum<string>
Available options:
snapshot,
incremental
sourceConfig
object
columnMapping
object
schedule
object
autoEnroll
boolean
targetCampaignId
string
Available options:
pewc,
express,
ebr,
none

Response

The updated sync source.

success
boolean
required
data
object
required

A configured SYNC SOURCE bound to a contact list (the poll complement to outbound triggers): a connected integration that can list records → scheduled incremental sync → the list. A synced list with autoEnroll false is a reusable segment a campaign dials on launch; autoEnroll true also enrolls newly-synced valid contacts into a running targetCampaignId. The sync cursor is internal and not surfaced.

message
string
errors
object[]