Skip to main content
PATCH
Updates a connector in place. Every field is optional and only the fields you send change, so it is safe to call without re-sending anything else. Every field is checked before anything is saved, so if one is invalid, nothing changes. Credentials are saved before the other settings, so in the rare case of a server error after that, only the credentials may have changed; retrying the same request is safe.
  • custom_instructions sets the connector-level ingestion instructions, used by every resource that has no instructions of its own. Send "" to clear them. Up to 4,000 characters. They apply from the next sync; documents already synced are not processed again. See Custom Ingestion Instructions.
  • sync_interval_seconds sets how often scheduled syncs run. The allowed range depends on the provider and comes back in the response as min_sync_interval_seconds and max_sync_interval_seconds. Values outside it are rejected, and 0 resets to the provider default. The next sync is rescheduled right away, so a shorter interval takes effect immediately.
  • credentials reconnects the connector, for example after a token expired or was revoked. Send the provider’s full credential set, the same as on create. The connector keeps its id, resources and sync positions, and a reconnect-required state is cleared.
custom_instructions_updated and credentials_updated are present when the request changed those fields. Sending {} changes nothing and returns the current interval and the allowed range.

​
Errors

  • 400: custom_instructions is over 4,000 characters, or sync_interval_seconds is outside the provider’s range. Nothing is changed.
  • 404: no connector with this id in your workspace.
  • 422: credentials does not match the provider’s credential_schema.

Authorizations

​
Authorization
string
header
required

API key sent as a Bearer token: "Bearer prefix.secret"

Path Parameters

​
id
string
required

Connector ID

Example:

"HydraDoc1234"

Body

application/json

Connector update request

​
credentials
object

Provider-specific credentials. Their shape is the provider's credential_schema from GET /connectors/providers?id=<provider>, for example {"access_token": "..."}.

Example:
​
custom_instructions
string

Ingestion and indexing instructions for every resource on this connector that has no instructions of its own. Omit to leave unchanged; "" clears. Up to 4000 characters, applied from the next sync.

​
sync_interval_seconds
integer

How frequently the scheduler triggers incremental syncs, in seconds. Bounded per provider; send 0 or omit to use the provider default. Change it later with PATCH /connectors/{id}.

Example:

3600

Response

OK

​
connector_id
string

Connector this resource belongs to.

Example:

"conn_abc123"

​
credentials_updated
boolean

true when this request replaced the stored credentials and cleared any reconnect-required state.

Example:

true

​
custom_instructions_updated
boolean

true when this request set or cleared the connector-level custom_instructions. The change applies from the next sync.

Example:

true

​
max_sync_interval_seconds
integer

Largest sync_interval_seconds this connector's provider allows.

Example:

604800

​
min_sync_interval_seconds
integer

Smallest sync_interval_seconds this connector's provider allows. Values below it are rejected, never clamped.

Example:

300

​
next_sync_at
string

RFC3339 timestamp when the next scheduled sync will run.

Example:

"2026-07-02T18:00:00Z"

​
sync_interval_seconds
integer

How frequently the scheduler triggers incremental syncs, in seconds. Bounded per provider; send 0 or omit to use the provider default. Change it later with PATCH /connectors/{id}.

Example:

3600