curl --request PATCH \
--url https://api.askparable.com/api/tenant-connector-taps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"canonicalPersonSource": true,
"config": {
"catalogSlug": "<string>",
"materializedDefault": true,
"selectedFields": [
"<string>"
],
"storageUri": "<string>",
"systemDisabled": true
},
"description": "<string>",
"enabled": true,
"name": "<string>",
"outputSchema": {}
}
'import requests
url = "https://api.askparable.com/api/tenant-connector-taps/{id}"
payload = {
"canonicalPersonSource": True,
"config": {
"catalogSlug": "<string>",
"materializedDefault": True,
"selectedFields": ["<string>"],
"storageUri": "<string>",
"systemDisabled": True
},
"description": "<string>",
"enabled": True,
"name": "<string>",
"outputSchema": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
canonicalPersonSource: true,
config: {
catalogSlug: '<string>',
materializedDefault: true,
selectedFields: ['<string>'],
storageUri: '<string>',
systemDisabled: true
},
description: '<string>',
enabled: true,
name: '<string>',
outputSchema: {}
})
};
fetch('https://api.askparable.com/api/tenant-connector-taps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.askparable.com/api/tenant-connector-taps/{id}"
payload := strings.NewReader("{\n \"canonicalPersonSource\": true,\n \"config\": {\n \"catalogSlug\": \"<string>\",\n \"materializedDefault\": true,\n \"selectedFields\": [\n \"<string>\"\n ],\n \"storageUri\": \"<string>\",\n \"systemDisabled\": true\n },\n \"description\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"outputSchema\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"canonicalPersonSource": true,
"connectorTapId": "<string>",
"createdAt": "<string>",
"enabled": true,
"id": "<string>",
"kind": "override",
"name": "<string>",
"outputSchema": {},
"tenantConnectorId": "<string>",
"updatedAt": "<string>",
"artifactId": "<string>",
"config": {
"catalogSlug": "<string>",
"materializedDefault": true,
"selectedFields": [
"<string>"
],
"storageUri": "<string>",
"systemDisabled": true
},
"description": "<string>",
"enabledSince": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}updateTenantConnectorTap
PATCH /api/workspace-connector-taps/ Update mutable fields on an existing tap. The platform tap binding, workspace-connector binding, and artifact reference are immutable. OVERRIDE outputSchema writes use the same structural-identity rule as create. Existing subset rows created under the old rule keep working on read; enforcement is write-only (PARABLE-2165).
curl --request PATCH \
--url https://api.askparable.com/api/tenant-connector-taps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"canonicalPersonSource": true,
"config": {
"catalogSlug": "<string>",
"materializedDefault": true,
"selectedFields": [
"<string>"
],
"storageUri": "<string>",
"systemDisabled": true
},
"description": "<string>",
"enabled": true,
"name": "<string>",
"outputSchema": {}
}
'import requests
url = "https://api.askparable.com/api/tenant-connector-taps/{id}"
payload = {
"canonicalPersonSource": True,
"config": {
"catalogSlug": "<string>",
"materializedDefault": True,
"selectedFields": ["<string>"],
"storageUri": "<string>",
"systemDisabled": True
},
"description": "<string>",
"enabled": True,
"name": "<string>",
"outputSchema": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
canonicalPersonSource: true,
config: {
catalogSlug: '<string>',
materializedDefault: true,
selectedFields: ['<string>'],
storageUri: '<string>',
systemDisabled: true
},
description: '<string>',
enabled: true,
name: '<string>',
outputSchema: {}
})
};
fetch('https://api.askparable.com/api/tenant-connector-taps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.askparable.com/api/tenant-connector-taps/{id}"
payload := strings.NewReader("{\n \"canonicalPersonSource\": true,\n \"config\": {\n \"catalogSlug\": \"<string>\",\n \"materializedDefault\": true,\n \"selectedFields\": [\n \"<string>\"\n ],\n \"storageUri\": \"<string>\",\n \"systemDisabled\": true\n },\n \"description\": \"<string>\",\n \"enabled\": true,\n \"name\": \"<string>\",\n \"outputSchema\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"canonicalPersonSource": true,
"connectorTapId": "<string>",
"createdAt": "<string>",
"enabled": true,
"id": "<string>",
"kind": "override",
"name": "<string>",
"outputSchema": {},
"tenantConnectorId": "<string>",
"updatedAt": "<string>",
"artifactId": "<string>",
"config": {
"catalogSlug": "<string>",
"materializedDefault": true,
"selectedFields": [
"<string>"
],
"storageUri": "<string>",
"systemDisabled": true
},
"description": "<string>",
"enabledSince": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Workspace slug. Overrides subdomain-based workspace resolution when provided.
"acme"
Optional request correlation ID echoed back in the response.
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
id parameter UUID v4 with automatic base62 encoding for client-facing APIs
Body
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 (PARABLE-2165).
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.
============================================================================= TenantConnectorTap.config
Typed JSON payload for TenantConnectorTap.config (PARABLE-2063 / PARABLE-2222). 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.
- Option 1
- Option 2
Show child attributes
Show child attributes
An objects name
A Parable Schema in JSON
Response
Successful response
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 EDR-0021 for the model.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes