Skip to main content
PATCH
Updates one configured resource in place. Send custom_instructions, acl, or both. At least one is required, and any field you omit is left unchanged.
The response includes custom_instructions and acl only when the request set them, showing the stored values. resource_id in the path is the id from List Connector Resources, for example a Slack channel id or a Supabase schema.table name. URL-encode it if it contains spaces or other reserved characters.
  • custom_instructions replaces connector-level instructions for this resource. Send "" to inherit the connector’s instructions again. Changes affect future syncs. See Custom ingestion instructions.
  • acl changes access immediately, including for already-synced sources. Use ["__public__"] for public access or [] to deny everyone. An ACL captured from the provider may replace it on the next sync. See Query.

Errors

  • 400: neither field was sent, custom_instructions is over 4,000 characters, or acl is malformed. Nothing is changed.
  • 404: no connector with this id in your organization, or no configured resource with this resource_id on it.

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer <your_api_key>.

Path Parameters

id
string
required

Connector ID

Example:

"HydraDoc1234"

resource_id
string
required

Resource ID

Example:

"C0123456789"

Body

application/json

Resource settings to change

acl
string[]

Who can read this resource's objects: emails, group:<provider>:<id>, domain:<domain>, or ["__public__"]. [] allows nobody. Provider permissions, where read, take over at the next sync.

custom_instructions
string

Ingestion and indexing instructions for this resource, replacing the connector's. Omit to leave unchanged; "" clears back to the connector's. Up to 4000 characters, applied from the next sync.

Response

OK

connector_id
string
required

Connector this resource belongs to.

Example:

"conn_abc123"

resource_id
string
required

Resource identifier from the Discover endpoint.

Example:

"C0123456789"

acl
string[]

The access rule as stored. Present only when the request set acl.

custom_instructions
string

The resource's instructions as stored; "" means they were cleared. Present only when the request set them.

custom_instructions_updated
boolean

true when this request set or cleared the resource's custom_instructions.

Example:

true