Skip to main content
PATCH
TypeScript SDK

Change a Tap's settings

change_tap_settings

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

id
string
required

id parameter UUID v4 with automatic base62 encoding for client-facing APIs

Body

application/json

Patch input for updating an existing workspace connector tap. Same optional fields as create's nested tap body so both paths validate through one shape.

canonicalPersonSource
boolean | null

Mark this tap as one of the Workspace's canonical person/identity sources. Any number of active taps may carry the designation; ordering among canonical sources is by tap creation time, earlier wins. Null on create = false. Null on update = leave unchanged.

config
object

============================================================================= provider connection.config

Typed JSON payload for provider connection.config /. Kind-dependent keys share one object: OVERRIDE/CUSTOM may set selectedFields; ARTIFACT uses catalogSlug + storageUri; promotion sets materializedDefault. Only these keys are preserved across typed config round-trips; undeclared JSON keys are dropped when the control plane marshals this type.

description
string | null
enabled
boolean | null
name
string | null

An objects name

Required string length: 2 - 80
outputSchema
object | null

A Parable Schema in JSON

Response

Successful response

data
object
required

Per-workspace tap configuration. Either narrows a platform ConnectorTap's output schema for this workspace (override case) or stands in for an artifact-derived tap (artifact case). See for the model.

meta
object
required