Skip to main content
PATCH
Update a source connector

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required
source_id
string
required

Body

application/json
enabled
boolean
name
string
Minimum string length: 1
dataset
string
Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,62}$
poll_interval
integer

Seconds, clamped up to the plan minimum.

cursor_column
string
Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
type
enum<string>
Available options:
postgres
config
object

Merged over the stored config, then validated whole.

Response

Updated.

ok
enum<boolean>
required
Available options:
true
poll_interval
integer

Present when the interval changed: the value stored.