Skip to main content
PATCH
/
outbound
/
lists
/
{id}
/
sources
/
{sourceId}
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "listId": "<string>",
    "enabled": true,
    "organizationId": "<string>",
    "connectionId": "<string>",
    "sourceConfig": {},
    "columnMapping": {},
    "schedule": {},
    "autoEnroll": true,
    "targetCampaignId": "<string>",
    "lastSyncedAt": "<string>",
    "lastStatus": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Clerk JWT (browser). Requires Authorization: Bearer <clerk_jwt> and the X-Organization-Id header. Validated by the ported Clerk middleware, which sets the app.current_organization_id RLS context.

Path Parameters

​
id
string
required
​
sourceId
string
required

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
​
consentBasis
enum<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[]