A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "obs_5c1a9e3d7b204f6a",
"organizationId": "org_2Yh1kQ",
"listId": "obl_7a3f21c9e5b04d68",
"sourceKind": "google_sheets",
"connectionId": "intg_9d41ee7720ab",
"columnMapping": {
"phone": "Phone",
"name": "First Name"
},
"syncMode": "snapshot",
"schedule": {
"intervalMinutes": 30
},
"autoEnroll": true,
"targetCampaignId": "obc_2d8e14f7a9c3b0e6",
"consentBasis": "ebr",
"enabled": true,
"lastSyncedAt": "2026-07-13T16:00:00.000Z",
"lastStatus": "success",
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T17:00:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Update a sync source
Apply a partial change to a sync source (enable/disable, schedule, column mapping, source config, sync mode, consent basis, or auto-enroll + its target campaign). An omitted field is left unchanged. Enabling autoEnroll requires a targetCampaignId that dials this list.
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "obs_5c1a9e3d7b204f6a",
"organizationId": "org_2Yh1kQ",
"listId": "obl_7a3f21c9e5b04d68",
"sourceKind": "google_sheets",
"connectionId": "intg_9d41ee7720ab",
"columnMapping": {
"phone": "Phone",
"name": "First Name"
},
"syncMode": "snapshot",
"schedule": {
"intervalMinutes": 30
},
"autoEnroll": true,
"targetCampaignId": "obc_2d8e14f7a9c3b0e6",
"consentBasis": "ebr",
"enabled": true,
"lastSyncedAt": "2026-07-13T16:00:00.000Z",
"lastStatus": "success",
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T17:00:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
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.
- Token URL
- /api/v1/api-keys
Path Parameters
The contact-list id the source belongs to.
The sync-source id (returned by createOutboundListSource / listOutboundListSources).
Body
A partial update — an omitted field is left unchanged.
Response
The updated sync source.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes