{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}
{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}
{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}
Installation
Update an installation object
Updates a single object’s configuration within an installation using JSON Patch syntax.
{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}
{
"type": "about:blank",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Bad Request",
"status": 400,
"detail": "The input message is incorrect",
"instance": "123456-1234-1235-4567489798",
"issues": [
{
"type": "about:blank",
"detail": "exampleNumericProperty should be numeric",
"in": "path",
"name": "exampleNumericProperty",
"value": "abc"
},
{
"type": "about:blank",
"title": "Input isn't valid with respect to schema",
"detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
"in": "body",
"name": "items[0].examplePropertyWithPattern",
"value": "a2345678901"
}
]
}
{
"type": "urn:problem-type:exampleOrganization:exampleProblem",
"href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
"title": "Description of the type of problem that occurred",
"status": 400,
"detail": "Description of specific occurrence of the problem",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}
Authorizations
APIKeyHeaderBearer
X-Api-Key
string
header
required
Path Parameters
projectIdOrName
string
required
The Ampersand project ID or project name.
integrationId
string
required
The integration ID.
objectName
string
required
The object name whose config content will be patched.
Must match an object name defined in the integration's manifest for the specified action type (read, subscribe, or write).
Common examples include: account, contact, lead, opportunity (for Salesforce), deal, company (for HubSpot), etc.
Body
application/json
Option 1
Option 2
groupRef
string
required
The ID of the user group that has access to this installation.
Either groupRef or installationId must be provided.
Example:
"group-123"
action
enum<string>
required
The action type for the object config (read, subscribe, or write).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ampersand","colors":{"primary":"#1F71D6","light":"#F3F89B","dark":"#2B2B2B"},"logo":{"light":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/light.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=7799b7c055eff93e5275bfee4335494b","dark":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/dark.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=e83684af7f0f30de3c40d300c6e38ecf","href":"https://www.ampersand.ai"},"favicon":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/favicon.svg?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=a58cf520454ff09433cb78f5ce10b2f2","api":{"openapi":["platform.json","read.json","write.json","search.json"]},"background":{"color":{"light":"#FDFBF9","dark":"#121212"}},"navbar":{"links":[{"href":"https://dashboard.withampersand.com/sign-in?trk=docs","label":"Sign in"}],"primary":{"type":"button","label":"Start building now","href":"https://dashboard.withampersand.com/sign-up?trk=docs"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/withampersand","twitter":"https://twitter.com/withampersand"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Helvetica Neue","weight":600,"source":"fonts/HelveticaNeue/HelveticaNeueMedium.woff2","format":"woff2"},"body":{"family":"Helvetica Neue","weight":500,"source":"fonts/HelveticaNeue/HelveticaNeueRoman.woff2","format":"woff2"}},"styling":{"codeblocks":"dark","latex":false},"integrations":{"gtm":{"tagId":"GTM-KKG4NLZD"}},"contextual":{"options":["copy","view"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ampersand-24eb5c1a","hasAudioNarration":false,"actualSubdomain":"ampersand-24eb5c1a","customDomains":["docs.ampersand.ai"],"gitSource":{"type":"github","owner":"amp-labs","repo":"docs","deployBranch":"main","contentDirectory":"src","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afba4d88ec88c31b27205a9","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Integrations","count":434},{"language":"default","tag":"All providers","count":203},{"language":"default","tag":"API Reference","count":91},{"language":"default","tag":"PLATFORM API","count":82},{"language":"default","tag":"Guides","count":37},{"language":"default","tag":"Customer guides","count":13},{"language":"default","tag":"Destinations","count":13},{"language":"default","tag":"Destination","count":12},{"language":"default","tag":"Org","count":12},{"language":"default","tag":"Installation","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"troubleshooting.css","content":".amp-ts{margin-top:1.5rem;letter-spacing:-0.0125rem}.amp-ts [hidden]{display:none!important}.amp-ts-controls{display:flex;flex-wrap:wrap;gap:10px;align-items:center}.amp-ts input.amp-ts-search{flex:1;min-width:240px;height:38px;padding:0 12px;border-radius:12px;border:1px solid var(--amp-border);background:var(--amp-surface-2);color:var(--amp-fg);font-size:15px;outline:none;transition:border-color 120ms ease}.amp-ts input.amp-ts-search:focus{border-color:var(--amp-accent)}.amp-ts input.amp-ts-search::placeholder{color:var(--amp-faint)}.amp-ts-chips{display:flex;flex-wrap:wrap;gap:8px}.amp-ts button.amp-ts-chip{height:32px;padding:0 12px;border:1px solid var(--amp-border);border-radius:12px;background:var(--amp-surface);color:var(--amp-muted);font-size:14px;font-family:inherit;cursor:pointer;transition:border-color 120ms ease, color 120ms ease}.amp-ts button.amp-ts-chip:hover{border-color:var(--amp-border-hover);color:var(--amp-fg)}.amp-ts button.amp-ts-chip.is-active{border-color:var(--amp-accent);color:var(--amp-accent)}.amp-ts-list{margin-top:6px}.amp-ts a.amp-ts-row{display:grid;grid-template-columns:minmax(0, 1fr) auto;align-items:center;gap:16px;padding:14px 4px;border-bottom:1px solid var(--amp-border-2);color:inherit;text-decoration:none;border-radius:0}.amp-ts a.amp-ts-row:hover .amp-ts-title{color:var(--amp-accent)}.amp-ts-title{font-size:16px;font-weight:500;color:var(--amp-fg);transition:color 120ms ease}.amp-ts-title code{font-size:13px}.amp-ts-desc{margin-top:4px;font-size:15px;line-height:1.6;color:var(--amp-muted)}.amp-ts-tag{font-family:var(--amp-mono);font-size:12px;color:var(--amp-muted-2);white-space:nowrap}.amp-ts-count{margin-top:12px;font-family:var(--amp-mono);font-size:12px;color:var(--amp-muted-2)}"},{"filePath":"fonts.css","content":"@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueThin.woff2\") format(\"woff2\");font-weight:100;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueLight.woff2\") format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueRoman.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueMedium.woff2\") format(\"woff2\");font-weight:500 600;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueBold.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueBlack.woff2\") format(\"woff2\");font-weight:900;font-style:normal;font-display:swap}"},{"filePath":"provider-grid.css","content":"html[data-current-path=\"/provider-guides/overview\"] #header{display:none}html[data-current-path=\"/provider-guides/overview\"] .mdx-content{max-width:none;margin-top:0}.amp-intg{max-width:1180px;margin:0 auto;color:var(--amp-fg);line-height:1.5}.amp-intg *{box-sizing:border-box}.amp-intg a{color:inherit;text-decoration:none}.amp-find-status,.amp-orbit-core i,.amp-node-label,.amp-intg-card-code,.amp-intg-card-cta{font-family:var(--amp-mono)}.amp-find-status,.amp-intg-head-sub{color:var(--amp-muted-2)}.amp-intg-eyebrow,.amp-intg-title-accent,.amp-intg-card-code,.amp-intg-card-cta{color:var(--amp-accent)}.amp-find-input,.amp-node a,.amp-node-label,.amp-cat-chips a,.amp-intg-card{border:1px solid var(--amp-border);background:var(--amp-surface)}.amp-cat-chips a:hover,.amp-cat-chips a:focus-visible,.amp-intg-card:hover{border-color:var(--amp-border-hover)}.amp-node a:focus-visible,.amp-cat-head:focus-visible{outline:2px solid var(--amp-accent)}.amp-intg-hero{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1.05fr);gap:56px;align-items:center;padding:40px 0 8px}.amp-intg-eyebrow{font-size:14px;font-weight:500;margin-bottom:12px}.amp-intg h1.amp-intg-title{margin:0;font-size:36px;line-height:44px;letter-spacing:-0.025em;font-weight:600;text-wrap:pretty}.amp-intg p.amp-intg-lede{margin:20px 0 0;font-size:16px;line-height:1.6;color:var(--amp-muted);max-width:46ch;text-wrap:pretty}.amp-find{margin-top:28px;max-width:360px}.amp-find-input{width:100%;height:40px;padding:0 12px;border-radius:8px;color:inherit;font:inherit;font-size:14px;outline:none;transition:border-color 120ms ease}.amp-find-input:focus{border-color:var(--amp-accent)}.amp-find-input::placeholder{color:var(--amp-faint)}.amp-find-status{margin-top:10px;font-size:11.5px;min-height:16px}.amp-orbit{position:relative;width:min(100%, 540px);aspect-ratio:1;margin:0 auto;container-type:inline-size}.amp-orbit::before,.amp-orbit::after{content:\"\";position:absolute;left:50%;top:50%;border-radius:50%;border:1px solid var(--amp-border-2);transform:translate(-50%, -50%);pointer-events:none}.amp-orbit::before{width:52cqw;height:52cqw}.amp-orbit::after{width:86cqw;height:86cqw;border-style:dashed}.amp-orbit-core{position:absolute;left:50%;top:50%;width:15cqw;height:15cqw;transform:translate(-50%, -50%);display:flex;flex-direction:column;align-items:center;justify-content:center;border-radius:50%;background:var(--amp-accent);box-shadow:0 10px 30px var(--amp-accent-soft);transition:transform 200ms ease, box-shadow 200ms ease}.amp-intg a.amp-orbit-core{color:#fff}html.dark .amp-intg a.amp-orbit-core{color:var(--amp-surface)}.amp-orbit-core:hover,.amp-orbit-core:focus-visible{transform:translate(-50%, -50%) scale(1.06);box-shadow:0 14px 36px var(--amp-accent-soft)}.amp-orbit-core b{font-size:4.2cqw;font-weight:600;line-height:1}.amp-orbit-core i{font-size:2.1cqw;font-style:normal;opacity:0.88;line-height:1.5}.amp-node{position:absolute;left:50%;top:50%;transform:translate(-50%, -50%)\n rotate(var(--a))\n translate(var(--r))\n rotate(calc(-1 * var(--a)))}.amp-node a{position:relative;display:grid;place-items:center;width:var(--sz);height:var(--sz);border-radius:50%;transition:transform 200ms cubic-bezier(0.34, 1.4, 0.64, 1), border-color 200ms ease}.amp-node--lg{--sz: 15cqw}.amp-node--sm{--sz: 9.5cqw}.amp-node img{width:62%;height:62%;object-fit:contain;border-radius:6px;background:#ffffff;padding:3%;pointer-events:none}.amp-node a:hover,.amp-node a:focus-visible{border-color:var(--amp-accent)}.amp-node--sm a:hover{transform:scale(1.12)}.amp-node a:focus-visible{outline-offset:3px}.amp-node:has(a:hover),.amp-node:has(a:focus-visible){z-index:3}.amp-node-label{position:absolute;top:calc(100% + 7px);left:50%;transform:translateX(-50%) translateY(3px);padding:3px 9px;border-radius:6px;font-size:11.5px;white-space:nowrap;opacity:0;pointer-events:none;transition:opacity 160ms ease, transform 160ms ease}.amp-node a:hover .amp-node-label,.amp-node a:focus-visible .amp-node-label{opacity:1;transform:translateX(-50%) translateY(0)}.amp-intg-section{padding-top:56px}.amp-intg-section--last{padding-bottom:72px}.amp-intg-head{display:flex;align-items:baseline;gap:14px;padding-bottom:18px;border-bottom:1px solid var(--amp-border-2)}.amp-intg h2.amp-intg-head-title{margin:0;font-size:15px;font-weight:600}.amp-intg-head-sub{font-size:13.5px}.amp-cats{margin-top:8px}.amp-cat{border-bottom:1px solid var(--amp-border-3)}.amp-cat-head{display:grid;grid-template-columns:10px minmax(0, 1fr);align-items:center;gap:14px;padding:17px 4px;cursor:pointer;user-select:none}.amp-cat-head:hover .amp-cat-name,.amp-cat-head:hover .amp-intg-head-title{color:var(--amp-accent)}.amp-cat-head:focus-visible{outline-offset:2px;border-radius:4px}.amp-cat-caret{width:0;height:0;border-left:5px solid var(--amp-faint);border-top:4px solid transparent;border-bottom:4px solid transparent;transition:transform 160ms ease}.amp-cat[data-open=\"true\"] .amp-cat-caret{transform:rotate(90deg);border-left-color:var(--amp-accent)}.amp-cat-name{font-size:14.5px;font-weight:500;letter-spacing:-0.005em;transition:color 120ms ease}.amp-cat:not([data-open=\"true\"]) .amp-cat-chips{display:none}.amp-cat-chips{display:flex;flex-wrap:wrap;gap:8px;padding:2px 4px 22px 24px}.amp-cat--section{border-bottom:0}.amp-intg-head.amp-cat-head{display:flex;align-items:baseline;padding:0 0 18px}.amp-cat--section .amp-cat-caret{align-self:center}.amp-cat--section .amp-cat-chips{padding-top:20px}.amp-cat-chips a{display:inline-flex;align-items:center;height:32px;padding:0 12px;border-radius:7px;font-size:13px;color:var(--amp-fg-2);white-space:nowrap;transition:border-color 120ms ease, color 120ms ease}.amp-cat-chips a:hover,.amp-cat-chips a:focus-visible{color:var(--amp-fg)}.amp-intg-cards{display:grid;grid-template-columns:repeat(auto-fit, minmax(260px, 1fr));gap:16px;margin-top:20px}.amp-intg-card{display:block;padding:20px;border-radius:10px;transition:border-color 120ms ease}.amp-intg-card-code{font-size:13.5px}.amp-intg-card-title{margin-top:10px;font-size:15px;font-weight:600;letter-spacing:-0.01em}.amp-intg-card-desc{margin-top:7px;font-size:14px;line-height:1.55;color:var(--amp-muted)}.amp-intg-card-cta{margin-top:14px;font-size:11.5px}@media (max-width: 960px){.amp-intg-hero{grid-template-columns:minmax(0, 1fr);gap:36px}.amp-intg h1.amp-intg-title{font-size:30px;line-height:38px}}@media (max-width: 640px){.amp-intg h1.amp-intg-title{font-size:27px;line-height:34px}.amp-intg-head{flex-direction:column;align-items:flex-start;gap:6px}.amp-cat-chips{padding-left:4px}}@media (prefers-reduced-motion: no-preference){.amp-node a{animation:amp-bob 6s ease-in-out infinite;animation-delay:var(--d, 0s)}.amp-node a:hover,.amp-node a:focus-visible{animation-play-state:paused}.amp-orbit::after{animation:amp-spin 90s linear infinite}}@keyframes amp-bob{0%,100%{translate:0 0}50%{translate:0 -5px}}@keyframes amp-spin{from{transform:translate(-50%, -50%) rotate(0deg)}to{transform:translate(-50%, -50%) rotate(360deg)}}@media (prefers-reduced-motion: reduce){.amp-node a{animation:none;transition:border-color 160ms ease}.amp-node--sm a:hover{transform:none}.amp-orbit::after{animation:none}.amp-cat-caret{transition:none}.amp-orbit-core:hover,.amp-orbit-core:focus-visible{transform:translate(-50%, -50%)}}.amp-cat[hidden],.amp-cat-chips a[hidden]{display:none!important}"},{"filePath":"shared-variables.css","content":":root{--amp-fg: rgb(var(--gray-900));--amp-fg-2: rgb(var(--gray-700));--amp-muted: rgb(var(--gray-600));--amp-muted-2: rgb(var(--gray-500));--amp-faint: rgb(var(--gray-400));--amp-accent: rgb(var(--primary));--amp-accent-hover: rgb(var(--primary-dark));--amp-accent-soft: rgb(var(--primary) / 0.16);--amp-surface: rgb(var(--background-light));--amp-surface-2: rgb(var(--gray-950) / 0.04);--amp-border: rgb(var(--gray-950) / 0.1);--amp-border-2: rgb(var(--gray-950) / 0.07);--amp-border-3: rgb(var(--gray-950) / 0.05);--amp-border-hover: rgb(var(--gray-950) / 0.22);--amp-mono: var(--font-family-mono-custom, var(--font-jetbrains-mono, ui-monospace)),\n \"SF Mono\", SFMono-Regular, Menlo, monospace}html.dark{--amp-fg: rgb(var(--gray-100));--amp-fg-2: rgb(var(--gray-300));--amp-muted: rgb(var(--gray-400));--amp-muted-2: rgb(var(--gray-400));--amp-faint: rgb(var(--gray-500));--amp-accent: rgb(var(--primary-light));--amp-accent-hover: rgb(var(--primary-light));--amp-accent-soft: rgb(var(--primary-light) / 0.22);--amp-surface: rgb(var(--background-dark));--amp-surface-2: rgb(255 255 255 / 0.05);--amp-border: rgb(255 255 255 / 0.13);--amp-border-2: rgb(255 255 255 / 0.09);--amp-border-3: rgb(255 255 255 / 0.07);--amp-border-hover: rgb(255 255 255 / 0.3)}"}],"page":{"pagePath":"reference/installation/update-an-installation-object","slug":"/reference/installation/update-an-installation-object","pageMetadata":{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/config-content","title":"Update an installation object","description":"Updates a single object's configuration within an installation using JSON Patch syntax.\n","href":"/reference/installation/update-an-installation-object"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a single object’s configuration within an installation using JSON Patch syntax.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/config-content","title":"Update an installation object","description":"Updates a single object's configuration within an installation using JSON Patch syntax.\n","href":"/reference/installation/update-an-installation-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ampersand-24eb5c1a/918af64092960fd7/troubleshooting.js","/_mintlify/custom/ampersand-24eb5c1a/0bf41ceae2eadd8d/provider-grid.js","/_mintlify/custom/ampersand-24eb5c1a/8d356ec11ed170d1/analytics.js"],"openApiReferenceData":{"operation":{"summary":"Update an installation object","description":"Updates a single object's configuration within an installation using JSON Patch syntax.\n","operationId":"patchObjectConfigContent","tags":["Installation"],"parameters":["1415c0c4-6adb-4d2b-84c9-d09bee2e2a45","9148584b-49c4-4f76-9d2c-bc5b7a61ac86","0cf28904-6bad-4318-901f-fcd046ebea0e"],"requestBody":"c942011f-9db4-459b-b2b3-48a6dc25c306","responses":{"200":"4aa3e837-cd6d-465f-b965-1f34c5c5a704","400":"2e64989c-7f52-4c57-92a9-70b11d7905e8","404":"981f464b-6e5a-4c8c-95b1-a90f637f4e72","default":"c8f45424-8680-4cb9-a199-3da0dc8af954"},"x-codegen-request-body-name":"patchObjectConfigContent","method":"patch","type":"path","servers":["a45d937e-d53b-40fa-a6c9-c692a08fd546"],"security":["42ffc7b0-867d-4d7b-8bba-a386fba6a1b4","903de518-6c46-437f-a57c-88b1dd1d3ba0"],"path":"/projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/config-content","baseUrlOptions":["https://api.ampersand.ai/v1"],"title":"Update an installation object","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1415c0c4-6adb-4d2b-84c9-d09bee2e2a45":{"name":"projectIdOrName","in":"path","required":true,"description":"The Ampersand project ID or project name.","schema":{"type":"string","isRequired":true,"description":"The Ampersand project ID or project name.","uniqueKey":"","typeLabel":"string"},"example":"my-project"},"9148584b-49c4-4f76-9d2c-bc5b7a61ac86":{"name":"integrationId","in":"path","required":true,"description":"The integration ID.","schema":{"type":"string","isRequired":true,"description":"The integration ID.","uniqueKey":"","typeLabel":"string"}},"0cf28904-6bad-4318-901f-fcd046ebea0e":{"name":"objectName","in":"path","required":true,"description":"The object name whose config content will be patched.\nMust match an object name defined in the integration's manifest for the specified action type (read, subscribe, or write).\nCommon examples include: `account`, `contact`, `lead`, `opportunity` (for Salesforce), `deal`, `company` (for HubSpot), etc.\n","schema":{"type":"string","isRequired":true,"description":"The object name whose config content will be patched.\nMust match an object name defined in the integration's manifest for the specified action type (read, subscribe, or write).\nCommon examples include: `account`, `contact`, `lead`, `opportunity` (for Salesforce), `deal`, `company` (for HubSpot), etc.\n","uniqueKey":"","typeLabel":"string"},"example":"account"}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["groupRef","action","changes"],"properties":{"groupRef":{"type":"string","description":"The ID of the user group that has access to this installation.\nEither groupRef or installationId must be provided.\n","example":"group-123","isRequired":true,"uniqueKey":"oneOf.0.groupRef","typeLabel":"string"},"action":{"type":"string","enum":["read","subscribe","write"],"description":"The action type for the object config (read, subscribe, or write).","example":"read","isRequired":true,"uniqueKey":"oneOf.0.action","typeLabel":"enum\u003cstring>"},"changes":{"type":"array","minItems":1,"description":"Array of JSON Patch operations to apply.\n","items":{"title":"JSON Patch Operation","description":"Represents a single JSON Patch operation (RFC 6902).\nOnly supports add, remove, and replace operations for config updates.\n","required":["op","path"],"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace"],"description":"The operation to perform.\n- \"add\": Adds a new field or replaces an existing one at the specified path\n- \"remove\": Removes the field at the specified path\n- \"replace\": Replaces the value at the specified path\n","example":"replace","isRequired":true,"uniqueKey":"oneOf.0.changes.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"path":{"type":"string","description":"JSON Pointer path to the field to operate on (RFC 6901).\nAll paths must start with \"/\" (e.g., \"/schedule\", \"/selectedFields/phone\").\n","example":"/schedule","isRequired":true,"uniqueKey":"oneOf.0.changes.items.[INDEX].path","typeLabel":"string"},"value":{"description":"The value to set for add/replace operations.\nNot used for remove operations.\n","example":"*/10 * * * *","uniqueKey":"oneOf.0.changes.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.0.changes.items.[INDEX]","typeLabel":"JSON Patch Operation · object"},"example":[{"op":"replace","path":"/schedule","value":"*/10 * * * *"},{"op":"add","path":"/selectedFields/phone","value":true},{"op":"remove","path":"/selectedFields/billingcity"}],"isRequired":true,"uniqueKey":"oneOf.0.changes","typeLabel":"JSON Patch Operation · object[]"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["installationId","action","changes"],"properties":{"installationId":{"type":"string","description":"The installation ID.\nEither groupRef or installationId must be provided.\n","example":"installation-123","isRequired":true,"uniqueKey":"oneOf.1.installationId","typeLabel":"string"},"action":{"type":"string","enum":["read","subscribe","write"],"description":"The action type for the object config (read, subscribe, or write).","example":"read","isRequired":true,"uniqueKey":"oneOf.1.action","typeLabel":"enum\u003cstring>"},"changes":{"type":"array","minItems":1,"description":"Array of JSON Patch operations to apply.\n","items":{"title":"JSON Patch Operation","description":"Represents a single JSON Patch operation (RFC 6902).\nOnly supports add, remove, and replace operations for config updates.\n","required":["op","path"],"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace"],"description":"The operation to perform.\n- \"add\": Adds a new field or replaces an existing one at the specified path\n- \"remove\": Removes the field at the specified path\n- \"replace\": Replaces the value at the specified path\n","example":"replace","isRequired":true,"uniqueKey":"oneOf.1.changes.items.[INDEX].op","typeLabel":"enum\u003cstring>"},"path":{"type":"string","description":"JSON Pointer path to the field to operate on (RFC 6901).\nAll paths must start with \"/\" (e.g., \"/schedule\", \"/selectedFields/phone\").\n","example":"/schedule","isRequired":true,"uniqueKey":"oneOf.1.changes.items.[INDEX].path","typeLabel":"string"},"value":{"description":"The value to set for add/replace operations.\nNot used for remove operations.\n","example":"*/10 * * * *","uniqueKey":"oneOf.1.changes.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"oneOf.1.changes.items.[INDEX]","typeLabel":"JSON Patch Operation · object"},"example":[{"op":"replace","path":"/schedule","value":"*/10 * * * *"},{"op":"add","path":"/selectedFields/phone","value":true},{"op":"remove","path":"/selectedFields/billingcity"}],"isRequired":true,"uniqueKey":"oneOf.1.changes","typeLabel":"JSON Patch Operation · object[]"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"groupRef":"group-123","action":"read","changes":[{"op":"replace","path":"/schedule","value":"*/10 * * * *"},{"op":"add","path":"/selectedFields/phone","value":true},{"op":"remove","path":"/selectedFields/billingcity"}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4aa3e837-cd6d-465f-b965-1f34c5c5a704":{"description":"The updated installation","content":{"application/json":{"schema":{"title":"Installation","required":["config","connection","createTime","createdBy","healthStatus","id","integrationId","projectId"],"type":"object","properties":{"id":{"type":"string","description":"The installation ID.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"projectId":{"type":"string","description":"The Ampersand project ID.","example":"project-456","isRequired":true,"uniqueKey":"projectId","typeLabel":"string"},"integrationId":{"type":"string","description":"The integration ID.","isRequired":true,"uniqueKey":"integrationId","typeLabel":"string"},"healthStatus":{"type":"string","enum":["healthy","unhealthy"],"description":"The health status of the installation.","example":"healthy","isRequired":true,"uniqueKey":"healthStatus","typeLabel":"enum\u003cstring>"},"connection":{"title":"Connection","required":["id","createTime","group","consumer","projectId","provider","authScheme","status"],"type":"object","properties":{"id":{"type":"string","description":"The connection ID.","example":"connection-123","isRequired":true,"uniqueKey":"connection.id","typeLabel":"string"},"projectId":{"type":"string","description":"The Ampersand project ID.","example":"project-456","isRequired":true,"uniqueKey":"connection.projectId","typeLabel":"string"},"provider":{"type":"string","description":"The SaaS provider that this Connection is for.","example":"salesforce","isRequired":true,"uniqueKey":"connection.provider","typeLabel":"string"},"group":{"title":"Group","required":["createTime","groupName","groupRef","projectId"],"type":"object","properties":{"groupRef":{"type":"string","description":"The ID of the user group that has access to this installation.","example":"group-123","isRequired":true,"uniqueKey":"connection.group.groupRef","typeLabel":"string"},"groupName":{"type":"string","description":"The name of the user group that has access to this installation.","example":"Super Customer","isRequired":true,"uniqueKey":"connection.group.groupName","typeLabel":"string"},"projectId":{"type":"string","description":"The Ampersand project ID.","example":"project-456","isRequired":true,"uniqueKey":"connection.group.projectId","typeLabel":"string"},"createTime":{"type":"string","description":"The time the group was created.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","isRequired":true,"uniqueKey":"connection.group.createTime","typeLabel":"string\u003cdate-time>"},"updateTime":{"type":"string","description":"The time the group was last updated.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","uniqueKey":"connection.group.updateTime","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"connection.group","typeLabel":"Group · object"},"consumer":{"title":"Consumer","required":["consumerName","consumerRef","createTime","projectId"],"type":"object","properties":{"consumerRef":{"type":"string","description":"The consumer reference.","example":"consumer-123","isRequired":true,"uniqueKey":"connection.consumer.consumerRef","typeLabel":"string"},"consumerName":{"type":"string","description":"The name of the consumer.","example":"Super Customer","isRequired":true,"uniqueKey":"connection.consumer.consumerName","typeLabel":"string"},"projectId":{"type":"string","description":"The Ampersand project ID.","example":"project-456","isRequired":true,"uniqueKey":"connection.consumer.projectId","typeLabel":"string"},"createTime":{"type":"string","description":"The time the consumer was created.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","isRequired":true,"uniqueKey":"connection.consumer.createTime","typeLabel":"string\u003cdate-time>"},"updateTime":{"type":"string","description":"The time the consumer was last updated.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","uniqueKey":"connection.consumer.updateTime","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"connection.consumer","typeLabel":"Consumer · object"},"createTime":{"type":"string","description":"The time the connection was created.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","isRequired":true,"uniqueKey":"connection.createTime","typeLabel":"string\u003cdate-time>"},"authScheme":{"type":"string","description":"The authentication scheme used for this connection.","example":"oauth2/authorizationCode","enum":["none","apiKey","basic","oauth2/authorizationCode","oauth2/authorizationCodePKCE","oauth2/clientCredentials","oauth2/password"],"isRequired":true,"uniqueKey":"connection.authScheme","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The status of the connection.\n- `created`: The connection has just been created or the access token was just refreshed.\n- `working`: The connection has successfully been used to make a request.\n- `bad_credentials`: The connection encountered credential-related issues when making a request, or when attempting to refresh the access token.\n","example":"working","enum":["created","working","bad_credentials"],"isRequired":true,"uniqueKey":"connection.status","typeLabel":"enum\u003cstring>"},"providerApp":{"title":"Provider App","required":["clientId","createTime","id","projectId","provider"],"type":"object","properties":{"id":{"type":"string","description":"The provider app ID.","example":"provider-app-123","isRequired":true,"uniqueKey":"connection.providerApp.id","typeLabel":"string"},"projectId":{"type":"string","description":"The Ampersand project ID.","example":"project-456","isRequired":true,"uniqueKey":"connection.providerApp.projectId","typeLabel":"string"},"provider":{"type":"string","description":"The SaaS provider that this app connects to.","example":"salesforce","isRequired":true,"uniqueKey":"connection.providerApp.provider","typeLabel":"string"},"clientId":{"type":"string","description":"The OAuth client ID for this app.","example":"client-id-123","isRequired":true,"uniqueKey":"connection.providerApp.clientId","typeLabel":"string"},"createTime":{"type":"string","description":"The time the provider app was created.","format":"date-time","isRequired":true,"uniqueKey":"connection.providerApp.createTime","typeLabel":"string\u003cdate-time>"},"externalRef":{"type":"string","description":"The ID used by the provider to identify the app (optional).","example":"external-id-123","uniqueKey":"connection.providerApp.externalRef","typeLabel":"string"},"scopes":{"type":"array","description":"The OAuth scopes for this app.","items":{"type":"string","example":["oauth","offline","crm.read"],"uniqueKey":"connection.providerApp.scopes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"connection.providerApp.scopes","typeLabel":"string[]"},"metadata":{"title":"Provider App Metadata","type":"object","description":"Provider-specific configuration that extends the standard OAuth flow.","properties":{"authQueryParams":{"type":"object","description":"Additional query parameters to include in the OAuth authorization URL (e.g., optional_scope for HubSpot).","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"connection.providerApp.metadata.authQueryParams.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"connection.providerApp.metadata.authQueryParams.additionalProperties","typeLabel":"string[]"},"example":{"optional_scope":["automation.sequences.read"]},"uniqueKey":"connection.providerApp.metadata.authQueryParams","typeLabel":"object"},"providerParams":{"type":"object","description":"Provider-specific string values keyed by names (e.g., packageInstallURL for Salesforce, gcpProjectId and gcpPubSubTopicName for Gmail).","additionalProperties":{"type":"string","uniqueKey":"connection.providerApp.metadata.providerParams.additionalProperties","typeLabel":"string"},"example":{"packageInstallURL":"https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789","gcpProjectId":"my-gcp-project","gcpPubSubTopicName":"my-topic"},"uniqueKey":"connection.providerApp.metadata.providerParams","typeLabel":"object"}},"uniqueKey":"connection.providerApp.metadata","typeLabel":"Provider App Metadata · object"},"updateTime":{"type":"string","description":"The time the provider app was updated.","format":"date-time","uniqueKey":"connection.providerApp.updateTime","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"connection.providerApp","typeLabel":"Provider App · object"},"providerWorkspaceRef":{"type":"string","description":"If available, the identifier for the provider workspace (e.g. the Salesforce subdomain)","example":"provider-workspace-123","uniqueKey":"connection.providerWorkspaceRef","typeLabel":"string"},"providerConsumerRef":{"type":"string","description":"If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)","example":"provider-consumer-123","uniqueKey":"connection.providerConsumerRef","typeLabel":"string"},"updateTime":{"type":"string","description":"The time the connection was last updated.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","uniqueKey":"connection.updateTime","typeLabel":"string\u003cdate-time>"},"oauth2AuthorizationCode":{"title":"OAuth2 AuthorizationCode Token","type":"object","properties":{"accessToken":{"type":"object","required":["token"],"description":"The access token for the connection.","properties":{"token":{"type":"string","isRequired":true,"uniqueKey":"connection.oauth2AuthorizationCode.accessToken.token","typeLabel":"string"},"issuedAt":{"type":"string","format":"date-time","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"connection.oauth2AuthorizationCode.accessToken.issuedAt","typeLabel":"string\u003cdate-time>"},"expiresAt":{"type":"string","format":"date-time","example":"2024-10-22T18:55:28.456076Z","uniqueKey":"connection.oauth2AuthorizationCode.accessToken.expiresAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"connection.oauth2AuthorizationCode.accessToken","typeLabel":"object"},"refreshToken":{"type":"object","required":["token"],"description":"The refresh token to use for the connection.","properties":{"token":{"type":"string","isRequired":true,"uniqueKey":"connection.oauth2AuthorizationCode.refreshToken.token","typeLabel":"string"},"issuedAt":{"type":"string","format":"date-time","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"connection.oauth2AuthorizationCode.refreshToken.issuedAt","typeLabel":"string\u003cdate-time>"},"expiresAt":{"type":"string","format":"date-time","example":"2024-10-22T18:55:28.456076Z","uniqueKey":"connection.oauth2AuthorizationCode.refreshToken.expiresAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"connection.oauth2AuthorizationCode.refreshToken","typeLabel":"object"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"connection.oauth2AuthorizationCode.scopes.items.[INDEX]","typeLabel":"string"},"description":"The scopes for the tokens.","uniqueKey":"connection.oauth2AuthorizationCode.scopes","typeLabel":"string[]"}},"uniqueKey":"connection.oauth2AuthorizationCode","typeLabel":"OAuth2 AuthorizationCode Token · object"},"apiKey":{"type":"string","description":"The API key used while making the connection.","example":"api-key-123","uniqueKey":"connection.apiKey","typeLabel":"string"},"providerMetadata":{"title":"Provider Metadata","type":"object","additionalProperties":{"title":"Provider Metadata Info","type":"object","required":["value","source"],"properties":{"value":{"type":"string","description":"The value of the metadata field","example":"1234567890","isRequired":true,"uniqueKey":"connection.providerMetadata.additionalProperties.value","typeLabel":"string"},"source":{"type":"string","description":"The source of the metadata field","enum":["input","token","provider"],"example":"input","isRequired":true,"uniqueKey":"connection.providerMetadata.additionalProperties.source","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"The human-readable name for the field","example":"Account ID","uniqueKey":"connection.providerMetadata.additionalProperties.displayName","typeLabel":"string"}},"uniqueKey":"connection.providerMetadata.additionalProperties","typeLabel":"Provider Metadata Info · object"},"uniqueKey":"connection.providerMetadata","typeLabel":"Provider Metadata · object"}},"isRequired":true,"uniqueKey":"connection","typeLabel":"Connection · object"},"createTime":{"type":"string","description":"The time the installation was created.","format":"date-time","isRequired":true,"uniqueKey":"createTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The person who did the installation, in the format of \"consumer:{consumer-id}\".","example":"consumer:consumer-123","isRequired":true,"uniqueKey":"createdBy","typeLabel":"string"},"config":{"title":"Config","required":["content","createTime","createdBy","id","revisionId"],"type":"object","properties":{"id":{"type":"string","description":"The config ID.","example":"config-123","isRequired":true,"uniqueKey":"config.id","typeLabel":"string"},"revisionId":{"type":"string","description":"The ID of the revision that was current when this config was created or last updated.\n","example":"revision-123","isRequired":true,"uniqueKey":"config.revisionId","typeLabel":"string"},"createTime":{"type":"string","description":"The time the config was created.","format":"date-time","isRequired":true,"uniqueKey":"config.createTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The person who created the config, in the format of \"consumer:{consumer-id}\" or \"builder:{builder-id}\".","example":"builder:builder-123","isRequired":true,"uniqueKey":"config.createdBy","typeLabel":"string"},"content":{"type":"object","title":"Config Content","required":["provider"],"properties":{"provider":{"description":"The SaaS API that we are integrating with.","example":"hubspot","type":"string","isRequired":true,"uniqueKey":"config.content.provider","typeLabel":"string"},"read":{"type":"object","title":"Read Config","required":["objects"],"properties":{"objects":{"type":"object","description":"This is a map of object names to their configuration.","additionalProperties":{"type":"object","title":"Read Config Object","required":["objectName","selectedFields","selectedFieldMappings"],"properties":{"objectName":{"type":"string","description":"The name of the object to read from.","x-oapi-codegen-extra-tags":{"validate":"required"},"example":"account","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.objectName","typeLabel":"string"},"selectedFields":{"type":"object","description":"This is a map of field names to booleans indicating whether they should be read. If a field is already included in `selectedFieldMappings`, it does not need to be included here.","example":"{ phone: true, fax: true }","additionalProperties":{"type":"boolean","uniqueKey":"config.content.read.objects.additionalProperties.selectedFields.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.selectedFields","typeLabel":"object"},"selectedFieldMappings":{"type":"object","description":"This is a map of mapToNames to field names. (A mapTo name is the name the builder wants to map a field to when it lands in their destination.)","example":"{ phoneNumber: phone, faxNumber: fax }","additionalProperties":{"type":"string","uniqueKey":"config.content.read.objects.additionalProperties.selectedFieldMappings.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.selectedFieldMappings","typeLabel":"object"},"schedule":{"type":"string","description":"The schedule for reading the object, in cron syntax.","x-go-type-skip-optional-pointer":true,"example":"*/15 * * * *","uniqueKey":"config.content.read.objects.additionalProperties.schedule","typeLabel":"string"},"disabled":{"type":"boolean","description":"If this flag is set to true, scheduled reads associated with this object will be paused, and on-demand reads will not be allowed.","default":false,"uniqueKey":"config.content.read.objects.additionalProperties.disabled","typeLabel":"boolean"},"destination":{"type":"string","description":"The name of the destination that the result should be sent to.","x-go-type-skip-optional-pointer":true,"example":"accountWebhook","uniqueKey":"config.content.read.objects.additionalProperties.destination","typeLabel":"string"},"selectedValueMappings":{"type":"object","description":"This is a map of field names to their value mappings.","x-go-type-skip-optional-pointer":true,"example":{"stage":{"open":"scheduled","closedWon":"won","closedLost":"lost"}},"additionalProperties":{"type":"object","title":"Selected Value Mappings","description":"This is a map of values to their mappings. The key is the value delivered to the webhook, the value is the value coming from the provider API.","x-go-type-skip-optional-pointer":true,"example":{"open":"scheduled","closedWon":"won","closedLost":"lost"},"additionalProperties":{"type":"string","uniqueKey":"config.content.read.objects.additionalProperties.selectedValueMappings.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"config.content.read.objects.additionalProperties.selectedValueMappings.additionalProperties","typeLabel":"Selected Value Mappings · object"},"uniqueKey":"config.content.read.objects.additionalProperties.selectedValueMappings","typeLabel":"object"},"dynamicMappingsInput":{"type":"array","items":{"type":"object","title":"Field Mapping Entry","required":["mapToName"],"properties":{"mapToName":{"type":"string","description":"The name of the field in your application.","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].mapToName","typeLabel":"string"},"mapToDisplayName":{"type":"string","description":"Optional display name of the field to show the user in the mapping UI.","uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].mapToDisplayName","typeLabel":"string"},"prompt":{"type":"string","description":"Optional prompt to show the user in the mapping UI.","uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].prompt","typeLabel":"string"},"mappedValues":{"type":"array","items":{"type":"object","title":"Mapped Value","required":["mappedValue","mappedDisplayValue"],"properties":{"mappedValue":{"type":"string","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].mappedValues.items.[INDEX].mappedValue","typeLabel":"string"},"mappedDisplayValue":{"type":"string","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].mappedValues.items.[INDEX].mappedDisplayValue","typeLabel":"string"}},"uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].mappedValues.items.[INDEX]","typeLabel":"Mapped Value · object"},"description":"If you would like the user to map a set of possible values, this is the list of possible values of the field in your application.","uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].mappedValues","typeLabel":"Mapped Value · object[]"},"fieldName":{"type":"string","description":"The name of the field in SaaS provider, if present, then we will not prompt the user to map the field.","uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX].fieldName","typeLabel":"string"}},"uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput.items.[INDEX]","typeLabel":"Field Mapping Entry · object"},"title":"Dynamic Mappings Input","description":"An array containing all available dynamic field and value mappings for this installation, provided by the InstallIntegration component. This array represents the complete set of possible mappings, regardless of which ones are currently selected. The actual selected mappings are stored separately in the selectedFieldMappings property.","uniqueKey":"config.content.read.objects.additionalProperties.dynamicMappingsInput","typeLabel":"Field Mapping Entry · object[]"},"selectedFieldsAuto":{"type":"string","title":"Selected Fields Auto Config","description":"If selectedFieldsAuto is set to all, all fields will be read.","enum":["all"],"x-enum-varnames":["SelectedFieldsAll"],"uniqueKey":"config.content.read.objects.additionalProperties.selectedFieldsAuto","typeLabel":"enum\u003cstring>"},"backfill":{"type":"object","title":"Backfill Config","required":["defaultPeriod"],"properties":{"defaultPeriod":{"type":"object","title":"Default Period Config","properties":{"days":{"type":"integer","description":"Number of days in past to backfill from. 0 is no backfill. e.g) if 10, then backfill last 10 days of data. Required if fullHistory is not set.","minimum":0,"x-oapi-codegen-extra-tags":{"validate":"required_without=FullHistory,omitempty,min=0"},"example":30,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.defaultPeriod.days","typeLabel":"integer"},"fullHistory":{"type":"boolean","description":"If true, backfill all history. Required if days is not set.","x-oapi-codegen-extra-tags":{"validate":"required_without=Days"},"example":false,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.defaultPeriod.fullHistory","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.defaultPeriod","typeLabel":"Default Period Config · object"},"fieldFilters":{"type":"array","items":{"type":"object","title":"Read Filter","required":["fieldName","operator"],"properties":{"fieldName":{"type":"string","description":"The name of the field to filter on.","example":"status","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.fieldFilters.items.[INDEX].fieldName","typeLabel":"string"},"operator":{"type":"string","description":"The comparison operator.","enum":["eq"],"example":"eq","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.fieldFilters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"title":"Read Filter Value","description":"The value to filter on. Allowed types are string, boolean, and number.","example":"active","uniqueKey":"config.content.read.objects.additionalProperties.backfill.fieldFilters.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"config.content.read.objects.additionalProperties.backfill.fieldFilters.items.[INDEX]","typeLabel":"Read Filter · object"},"description":"Filters to apply only during backfill. Multiple conditions are joined by AND. Use this when you want different filter behavior for backfill vs. incremental reads.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.fieldFilters","typeLabel":"Read Filter · object[]"},"rawFilter":{"type":"object","title":"Raw Filter","description":"A filter in the provider's native query syntax. It cannot be combined with fieldFilters. It can apply to incremental reads, backfills or a search API call.\n","required":["type","filter"],"properties":{"type":{"type":"string","description":"The syntax of the filter. Supported values are documented in each provider's guide. For example, `soql` is a supported filter type for Salesforce.\n","example":"soql","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.rawFilter.type","typeLabel":"string"},"filter":{"title":"Raw Filter Value","description":"The filter expression.","example":"IsDeleted = true OR IsDeleted = false","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.backfill.rawFilter.filter","typeLabel":"any"}},"uniqueKey":"config.content.read.objects.additionalProperties.backfill.rawFilter","typeLabel":"Raw Filter · object"}},"uniqueKey":"config.content.read.objects.additionalProperties.backfill","typeLabel":"Backfill Config · object"},"fieldFilters":{"type":"array","items":{"type":"object","title":"Read Filter","required":["fieldName","operator"],"properties":{"fieldName":{"type":"string","description":"The name of the field to filter on.","example":"status","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.fieldFilters.items.[INDEX].fieldName","typeLabel":"string"},"operator":{"type":"string","description":"The comparison operator.","enum":["eq"],"example":"eq","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.fieldFilters.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"title":"Read Filter Value","description":"The value to filter on. Allowed types are string, boolean, and number.","example":"active","uniqueKey":"config.content.read.objects.additionalProperties.fieldFilters.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"config.content.read.objects.additionalProperties.fieldFilters.items.[INDEX]","typeLabel":"Read Filter · object"},"description":"Filters to apply when reading records during incremental reads and backfill. Multiple conditions are joined by AND. Each field can only have one condition.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"config.content.read.objects.additionalProperties.fieldFilters","typeLabel":"Read Filter · object[]"},"rawFilter":{"type":"object","title":"Raw Filter","description":"A filter in the provider's native query syntax. It cannot be combined with fieldFilters. It can apply to incremental reads, backfills or a search API call.\n","required":["type","filter"],"properties":{"type":{"type":"string","description":"The syntax of the filter. Supported values are documented in each provider's guide. For example, `soql` is a supported filter type for Salesforce.\n","example":"soql","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.rawFilter.type","typeLabel":"string"},"filter":{"title":"Raw Filter Value","description":"The filter expression.","example":"IsDeleted = true OR IsDeleted = false","isRequired":true,"uniqueKey":"config.content.read.objects.additionalProperties.rawFilter.filter","typeLabel":"any"}},"uniqueKey":"config.content.read.objects.additionalProperties.rawFilter","typeLabel":"Raw Filter · object"}},"uniqueKey":"config.content.read.objects.additionalProperties","typeLabel":"Read Config Object · object"},"isRequired":true,"uniqueKey":"config.content.read.objects","typeLabel":"object"}},"uniqueKey":"config.content.read","typeLabel":"Read Config · object"},"write":{"type":"object","title":"Write Config","properties":{"objects":{"type":"object","description":"This is a map of object names to their configuration.","additionalProperties":{"type":"object","title":"Write Config Object","required":["objectName"],"properties":{"objectName":{"type":"string","description":"The name of the object to write to.","x-oapi-codegen-extra-tags":{"validate":"required"},"example":"account","isRequired":true,"uniqueKey":"config.content.write.objects.additionalProperties.objectName","typeLabel":"string"},"deletionSettings":{"type":"object","title":"Deletion Settings","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether deletion is enabled for this object","example":true,"isRequired":true,"uniqueKey":"config.content.write.objects.additionalProperties.deletionSettings.enabled","typeLabel":"boolean"}},"uniqueKey":"config.content.write.objects.additionalProperties.deletionSettings","typeLabel":"Deletion Settings · object"},"selectedValueDefaults":{"type":"object","description":"This is a map of field names to default values. These values will be used when writing to the object.","deprecated":true,"x-go-type-skip-optional-pointer":true,"additionalProperties":{"oneOf":[{"type":"object","title":"Value Default String","required":["value"],"deprecated":true,"x-go-type":"any","properties":{"value":{"type":"string","description":"The value to be used as a default.","isRequired":true,"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.0.value","typeLabel":"string"},"applyOnUpdate":{"type":"string","description":"Whether the default value should be applied when updating a record.\nIf set to `always`, the default value will be applied when updating a record.\nIf set to `never`, the default value will not be applied when updating a record,\nonly when creating a record.\nIf unspecified, then `always` is assumed.\n","enum":["always","never"],"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.0.applyOnUpdate","typeLabel":"enum\u003cstring>"}},"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.0","typeLabel":"Value Default String · object"},{"type":"object","title":"Value Default Integer","required":["value"],"deprecated":true,"x-go-type":"any","properties":{"value":{"type":"integer","description":"The value to be used as a default.","isRequired":true,"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.1.value","typeLabel":"integer"},"applyOnUpdate":{"type":"string","description":"Whether the default value should be applied when updating a record.\nIf set to `always`, the default value will be applied when updating a record.\nIf set to `never`, the default value will not be applied when updating a record,\nonly when creating a record.\nIf unspecified, then `always` is assumed.\n","enum":["always","never"],"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.1.applyOnUpdate","typeLabel":"enum\u003cstring>"}},"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.1","typeLabel":"Value Default Integer · object"},{"type":"object","title":"Value Default Boolean","required":["value"],"deprecated":true,"x-go-type":"any","properties":{"value":{"type":"boolean","description":"The value to be used as a default.","isRequired":true,"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.2.value","typeLabel":"boolean"},"applyOnUpdate":{"type":"string","description":"Whether the default value should be applied when updating a record.\nIf set to `always`, the default value will be applied when updating a record.\nIf set to `never`, the default value will not be applied when updating a record,\nonly when creating a record.\nIf unspecified, then `always` is assumed.\n","enum":["always","never"],"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.2.applyOnUpdate","typeLabel":"enum\u003cstring>"}},"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties.oneOf.2","typeLabel":"Value Default Boolean · object"}],"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults.additionalProperties","typeLabel":"Value Default String · object | Value Default Integer · object | Value Default Boolean · object"},"uniqueKey":"config.content.write.objects.additionalProperties.selectedValueDefaults","typeLabel":"object"},"selectedFieldSettings":{"type":"object","description":"This is a map of field names to their settings.","x-go-type-skip-optional-pointer":true,"additionalProperties":{"type":"object","title":"Field setting","properties":{"default":{"type":"object","title":"Default value for a field","description":"Only use one of stringValue, integerValue, booleanValue.","properties":{"stringValue":{"type":"string","description":"The default string value to apply to a field","uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties.default.stringValue","typeLabel":"string"},"integerValue":{"type":"integer","description":"The default integer value to apply to a field","uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties.default.integerValue","typeLabel":"integer"},"booleanValue":{"type":"boolean","description":"The default boolean value to apply to a field","uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties.default.booleanValue","typeLabel":"boolean"}},"uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties.default","typeLabel":"Default value for a field · object"},"writeOnCreate":{"type":"string","description":"Whether the default value should be applied when creating a record.","default":"always","enum":["always","never"],"x-go-type-skip-optional-pointer":true,"uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties.writeOnCreate","typeLabel":"enum\u003cstring>"},"writeOnUpdate":{"type":"string","description":"Whether the default value should be applied when updating a record.\n- always: Always write to the field on update\n- never: Never write to the field on update\n- ifEmpty: Only write to the field if it's currently empty (unset or empty string). \n","default":"always","enum":["always","never","ifEmpty"],"x-go-type-skip-optional-pointer":true,"uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties.writeOnUpdate","typeLabel":"enum\u003cstring>"}},"uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings.additionalProperties","typeLabel":"Field setting · object"},"uniqueKey":"config.content.write.objects.additionalProperties.selectedFieldSettings","typeLabel":"object"}},"uniqueKey":"config.content.write.objects.additionalProperties","typeLabel":"Write Config Object · object"},"uniqueKey":"config.content.write.objects","typeLabel":"object"}},"uniqueKey":"config.content.write","typeLabel":"Write Config · object"},"proxy":{"title":"Base Proxy Config","type":"object","properties":{"enabled":{"type":"boolean","uniqueKey":"config.content.proxy.enabled","typeLabel":"boolean"}},"uniqueKey":"config.content.proxy","typeLabel":"Base Proxy Config · object"},"subscribe":{"type":"object","title":"Subscribe Config","properties":{"objects":{"type":"object","description":"Per-object subscribe configuration. Optional: when omitted, the subscribe objects come from the integration revision, and the config may carry only `providerOptions`.","additionalProperties":{"type":"object","title":"Subscribe Config Object","required":["objectName","destination"],"properties":{"objectName":{"type":"string","description":"The name of the object to subscribe to.","x-oapi-codegen-extra-tags":{"validate":"required"},"example":"account","isRequired":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.objectName","typeLabel":"string"},"destination":{"type":"string","description":"The name of the destination that the result should be sent to.","example":"accountWebhook","isRequired":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.destination","typeLabel":"string"},"inheritFieldsAndMappings":{"oneOf":[{"type":"boolean","description":"Whether to inherit fields and mappings from the read config. When omitted, the integration's `inheritFieldsAndMapping` from amp.yaml is used. If true, fields and mappings come from the matching read config object. If false, nothing is inherited from the read config.","example":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.inheritFieldsAndMappings.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to inherit fields and mappings from the read config. When omitted, the integration's `inheritFieldsAndMapping` from amp.yaml is used. If true, fields and mappings come from the matching read config object. If false, nothing is inherited from the read config.","example":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.inheritFieldsAndMappings.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.content.subscribe.objects.additionalProperties.inheritFieldsAndMappings","typeLabel":"boolean | null"},"createEvent":{"type":"object","title":"Create Event","required":["enabled"],"properties":{"enabled":{"type":"string","description":"Conditions to enable create events.","enum":["always","never"],"x-oapi-codegen-extra-tags":{"validate":"oneof=always never"},"isRequired":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.createEvent.enabled","typeLabel":"enum\u003cstring>"}},"uniqueKey":"config.content.subscribe.objects.additionalProperties.createEvent","typeLabel":"Create Event · object"},"updateEvent":{"type":"object","title":"Update Event","required":["enabled"],"properties":{"enabled":{"type":"string","description":"Conditions to enable update events.","enum":["always","never"],"x-oapi-codegen-extra-tags":{"validate":"oneof=always never"},"example":"always","isRequired":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.updateEvent.enabled","typeLabel":"enum\u003cstring>"},"watchFieldsAuto":{"type":"string","description":"Whether to watch fields all fields automatically.","enum":["all"],"example":"all","uniqueKey":"config.content.subscribe.objects.additionalProperties.updateEvent.watchFieldsAuto","typeLabel":"enum\u003cstring>"},"requiredWatchFields":{"type":"array","items":{"type":"string","uniqueKey":"config.content.subscribe.objects.additionalProperties.updateEvent.requiredWatchFields.items.[INDEX]","typeLabel":"string"},"description":"The fields that should be watched.","example":["name","description"],"uniqueKey":"config.content.subscribe.objects.additionalProperties.updateEvent.requiredWatchFields","typeLabel":"string[]"}},"uniqueKey":"config.content.subscribe.objects.additionalProperties.updateEvent","typeLabel":"Update Event · object"},"deleteEvent":{"type":"object","title":"Delete Event","required":["enabled"],"properties":{"enabled":{"type":"string","description":"Conditions to enable delete events.","enum":["always","never"],"x-oapi-codegen-extra-tags":{"validate":"oneof=always never"},"example":"always","isRequired":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.deleteEvent.enabled","typeLabel":"enum\u003cstring>"}},"uniqueKey":"config.content.subscribe.objects.additionalProperties.deleteEvent","typeLabel":"Delete Event · object"},"otherEvents":{"type":"array","items":{"type":"string","description":"Non-standard events that the integration will subscribe to.","example":["object.merged","object.restored"],"uniqueKey":"config.content.subscribe.objects.additionalProperties.otherEvents.items.[INDEX]","typeLabel":"string"},"title":"Other Events","uniqueKey":"config.content.subscribe.objects.additionalProperties.otherEvents","typeLabel":"string[]"},"providerOptions":{"type":"object","title":"Subscribe Provider Options","description":"Per-object subscribe options that only apply to certain providers. Each option documents which providers support it; setting one for a provider that does not support it is rejected. Options that apply to the whole subscription live on `subscribe.providerOptions` instead.\n","properties":{"quotaOptimization":{"type":"object","title":"Quota Optimization Config","description":"Reduces API quota consumption for update events by filtering irrelevant change events at the source, so only updates that affect watched fields are delivered. Requires `updateEvent.requiredWatchFields` to be non-empty; it cannot be used with `updateEvent.watchFieldsAuto: all`. Currently supported for Salesforce.\n","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether quota optimization is enabled for this object.","example":true,"isRequired":true,"uniqueKey":"config.content.subscribe.objects.additionalProperties.providerOptions.quotaOptimization.enabled","typeLabel":"boolean"}},"uniqueKey":"config.content.subscribe.objects.additionalProperties.providerOptions.quotaOptimization","typeLabel":"Quota Optimization Config · object"}},"uniqueKey":"config.content.subscribe.objects.additionalProperties.providerOptions","typeLabel":"Subscribe Provider Options · object"}},"uniqueKey":"config.content.subscribe.objects.additionalProperties","typeLabel":"Subscribe Config Object · object"},"uniqueKey":"config.content.subscribe.objects","typeLabel":"object"},"providerOptions":{"title":"Subscribe Installation Provider Options","description":"Subscribe options that apply to the whole installation and only to certain providers. Each option documents which providers support it; setting one for a provider that does not support it is rejected. For options that are set per object, see `subscribe.objects.\u003cname>.providerOptions`.\n","type":"object","properties":{"useSalesforceFlows":{"title":"Use Salesforce Flows Config","description":"Opt this installation's Salesforce subscription into record-triggered flows and outbound messages instead of Change Data Capture. Delete events are not supported on this path. Defaults to false (CDC).\n","type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether this installation uses Salesforce record-triggered flows for subscribe.","example":true,"isRequired":true,"uniqueKey":"config.content.subscribe.providerOptions.useSalesforceFlows.enabled","typeLabel":"boolean"},"manualManagement":{"type":"boolean","description":"Whether the customer creates and maintains the flows and outbound messages in their Salesforce org themselves. When true, Ampersand never creates, updates or deletes them; the customer's outbound messages post to the installation's subscribe webhook URL. Requires `enabled` to be true. Defaults to false.\n","example":false,"uniqueKey":"config.content.subscribe.providerOptions.useSalesforceFlows.manualManagement","typeLabel":"boolean"}},"uniqueKey":"config.content.subscribe.providerOptions.useSalesforceFlows","typeLabel":"Use Salesforce Flows Config · object"}},"uniqueKey":"config.content.subscribe.providerOptions","typeLabel":"Subscribe Installation Provider Options · object"}},"uniqueKey":"config.content.subscribe","typeLabel":"Subscribe Config · object"}},"isRequired":true,"uniqueKey":"config.content","typeLabel":"Config Content · object"}},"isRequired":true,"uniqueKey":"config","typeLabel":"Config · object"},"group":{"title":"Group","required":["createTime","groupName","groupRef","projectId"],"type":"object","properties":{"groupRef":{"type":"string","description":"The ID of the user group that has access to this installation.","example":"group-123","isRequired":true,"uniqueKey":"group.groupRef","typeLabel":"string"},"groupName":{"type":"string","description":"The name of the user group that has access to this installation.","example":"Super Customer","isRequired":true,"uniqueKey":"group.groupName","typeLabel":"string"},"projectId":{"type":"string","description":"The Ampersand project ID.","example":"project-456","isRequired":true,"uniqueKey":"group.projectId","typeLabel":"string"},"createTime":{"type":"string","description":"The time the group was created.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","isRequired":true,"uniqueKey":"group.createTime","typeLabel":"string\u003cdate-time>"},"updateTime":{"type":"string","description":"The time the group was last updated.","format":"date-time","example":"2023-07-13T21:34:44.816354Z","uniqueKey":"group.updateTime","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"group","typeLabel":"Group · object"},"lastOperationStatus":{"type":"string","enum":["success","failure","in_progress"],"description":"The status of the latest operation for this installation.\n","example":"success","uniqueKey":"lastOperationStatus","typeLabel":"enum\u003cstring>"},"updateTime":{"type":"string","description":"The time the installation was last updated with a new config.","format":"date-time","uniqueKey":"updateTime","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"Installation · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","projectId":"project-456","integrationId":"\u003cstring>","healthStatus":"healthy","connection":{"id":"connection-123","projectId":"project-456","provider":"salesforce","group":{"groupRef":"group-123","groupName":"Super Customer","projectId":"project-456","createTime":"2023-07-13T21:34:44.816354Z","updateTime":"2023-07-13T21:34:44.816354Z"},"consumer":{"consumerRef":"consumer-123","consumerName":"Super Customer","projectId":"project-456","createTime":"2023-07-13T21:34:44.816354Z","updateTime":"2023-07-13T21:34:44.816354Z"},"createTime":"2023-07-13T21:34:44.816354Z","authScheme":"oauth2/authorizationCode","status":"working","providerApp":{"id":"provider-app-123","projectId":"project-456","provider":"salesforce","clientId":"client-id-123","createTime":"2023-11-07T05:31:56Z","externalRef":"external-id-123","scopes":[["oauth","offline","crm.read"]],"metadata":{"authQueryParams":{"optional_scope":["automation.sequences.read"]},"providerParams":{"packageInstallURL":"https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789","gcpProjectId":"my-gcp-project","gcpPubSubTopicName":"my-topic"}},"updateTime":"2023-11-07T05:31:56Z"},"providerWorkspaceRef":"provider-workspace-123","providerConsumerRef":"provider-consumer-123","updateTime":"2023-07-13T21:34:44.816354Z","oauth2AuthorizationCode":{"accessToken":{"token":"\u003cstring>","issuedAt":"2024-04-22T18:55:28.456076Z","expiresAt":"2024-10-22T18:55:28.456076Z"},"refreshToken":{"token":"\u003cstring>","issuedAt":"2024-04-22T18:55:28.456076Z","expiresAt":"2024-10-22T18:55:28.456076Z"},"scopes":["\u003cstring>"]},"apiKey":"api-key-123","providerMetadata":{}},"createTime":"2023-11-07T05:31:56Z","createdBy":"consumer:consumer-123","config":{"id":"config-123","revisionId":"revision-123","createTime":"2023-11-07T05:31:56Z","createdBy":"builder:builder-123","content":{"provider":"hubspot","read":{"objects":{}},"write":{"objects":{}},"proxy":{"enabled":true},"subscribe":{"objects":{},"providerOptions":{"useSalesforceFlows":{"enabled":true,"manualManagement":false}}}}},"group":{"groupRef":"group-123","groupName":"Super Customer","projectId":"project-456","createTime":"2023-07-13T21:34:44.816354Z","updateTime":"2023-07-13T21:34:44.816354Z"},"lastOperationStatus":"success","updateTime":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"2e64989c-7f52-4c57-92a9-70b11d7905e8":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"type":"object","title":"Input Validation Problem","description":"A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n","example":{"type":"about:blank","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Bad Request","status":400,"detail":"The input message is incorrect","instance":"123456-1234-1235-4567489798","issues":[{"type":"about:blank","detail":"exampleNumericProperty should be numeric","in":"path","name":"exampleNumericProperty","value":"abc"},{"type":"about:blank","title":"Input isn't valid with respect to schema","detail":"examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'","in":"body","name":"items[0].examplePropertyWithPattern","value":"a2345678901"}]},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"context","typeLabel":"object"},"issues":{"type":"array","items":{"type":"object","title":"Input Validation Issue","description":"An issue detected during input validation.\n","example":{"type":"urn:problem-type:exampleOrganization:exampleProblem","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Description of the type of problem that occurred","status":400,"detail":"Description of specific occurrence of the problem","instance":"urn:uuid:123e4567-e89b-12d3-a456-426614174000"},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"issues.items.[INDEX].type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"issues.items.[INDEX].href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"issues.items.[INDEX].title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"issues.items.[INDEX].status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"issues.items.[INDEX].detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"issues.items.[INDEX].instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"issues.items.[INDEX].subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"issues.items.[INDEX].time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"issues.items.[INDEX].requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"issues.items.[INDEX].causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"issues.items.[INDEX].causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"issues.items.[INDEX].remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"issues.items.[INDEX].supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"issues.items.[INDEX].supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"issues.items.[INDEX].supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"issues.items.[INDEX].retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"issues.items.[INDEX].retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"issues.items.[INDEX].context","typeLabel":"object"},"in":{"type":"string","description":"The location of the invalid input","enum":["body","header","path","query"],"uniqueKey":"issues.items.[INDEX].in","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the invalid input","uniqueKey":"issues.items.[INDEX].name","typeLabel":"string"},"value":{"description":"The value of the erroneous input","uniqueKey":"issues.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"Input Validation Issue · object"},"uniqueKey":"issues","typeLabel":"Input Validation Issue · object[]"}},"uniqueKey":"","typeLabel":"Input Validation Problem · object"},"examples":{"Example":{"title":"Example","value":{"type":"about:blank","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Bad Request","status":400,"detail":"The input message is incorrect","instance":"123456-1234-1235-4567489798","issues":[{"type":"about:blank","detail":"exampleNumericProperty should be numeric","in":"path","name":"exampleNumericProperty","value":"abc"},{"type":"about:blank","title":"Input isn't valid with respect to schema","detail":"examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'","in":"body","name":"items[0].examplePropertyWithPattern","value":"a2345678901"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"981f464b-6e5a-4c8c-95b1-a90f637f4e72":{"description":"Installation not found","content":{"application/problem+json":{"schema":{"type":"object","title":"Input Validation Problem","description":"A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n","example":{"type":"about:blank","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Bad Request","status":400,"detail":"The input message is incorrect","instance":"123456-1234-1235-4567489798","issues":[{"type":"about:blank","detail":"exampleNumericProperty should be numeric","in":"path","name":"exampleNumericProperty","value":"abc"},{"type":"about:blank","title":"Input isn't valid with respect to schema","detail":"examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'","in":"body","name":"items[0].examplePropertyWithPattern","value":"a2345678901"}]},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"context","typeLabel":"object"},"issues":{"type":"array","items":{"type":"object","title":"Input Validation Issue","description":"An issue detected during input validation.\n","example":{"type":"urn:problem-type:exampleOrganization:exampleProblem","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Description of the type of problem that occurred","status":400,"detail":"Description of specific occurrence of the problem","instance":"urn:uuid:123e4567-e89b-12d3-a456-426614174000"},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"issues.items.[INDEX].type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"issues.items.[INDEX].href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"issues.items.[INDEX].title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"issues.items.[INDEX].status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"issues.items.[INDEX].detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"issues.items.[INDEX].instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"issues.items.[INDEX].subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"issues.items.[INDEX].time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"issues.items.[INDEX].requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"issues.items.[INDEX].causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"issues.items.[INDEX].causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"issues.items.[INDEX].remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"issues.items.[INDEX].supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"issues.items.[INDEX].supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"issues.items.[INDEX].supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"issues.items.[INDEX].retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"issues.items.[INDEX].retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"issues.items.[INDEX].context","typeLabel":"object"},"in":{"type":"string","description":"The location of the invalid input","enum":["body","header","path","query"],"uniqueKey":"issues.items.[INDEX].in","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the invalid input","uniqueKey":"issues.items.[INDEX].name","typeLabel":"string"},"value":{"description":"The value of the erroneous input","uniqueKey":"issues.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"issues.items.[INDEX]","typeLabel":"Input Validation Issue · object"},"uniqueKey":"issues","typeLabel":"Input Validation Issue · object[]"}},"uniqueKey":"","typeLabel":"Input Validation Problem · object"},"examples":{"Example":{"title":"Example","value":{"type":"about:blank","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Bad Request","status":400,"detail":"The input message is incorrect","instance":"123456-1234-1235-4567489798","issues":[{"type":"about:blank","detail":"exampleNumericProperty should be numeric","in":"path","name":"exampleNumericProperty","value":"abc"},{"type":"about:blank","title":"Input isn't valid with respect to schema","detail":"examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'","in":"body","name":"items[0].examplePropertyWithPattern","value":"a2345678901"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c8f45424-8680-4cb9-a199-3da0dc8af954":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","title":"API Problem","description":"A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n","example":{"type":"urn:problem-type:exampleOrganization:exampleProblem","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Description of the type of problem that occurred","status":400,"detail":"Description of specific occurrence of the problem","instance":"urn:uuid:123e4567-e89b-12d3-a456-426614174000"},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"API Problem · object"},"examples":{"Example":{"title":"Example","value":{"type":"urn:problem-type:exampleOrganization:exampleProblem","href":"https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types","title":"Description of the type of problem that occurred","status":400,"detail":"Description of specific occurrence of the problem","instance":"urn:uuid:123e4567-e89b-12d3-a456-426614174000"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"42ffc7b0-867d-4d7b-8bba-a386fba6a1b4":{"APIKeyHeader":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"APIKeyHeader"}},"903de518-6c46-437f-a57c-88b1dd1d3ba0":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"a45d937e-d53b-40fa-a6c9-c692a08fd546":{"url":"https://api.ampersand.ai/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-Api-Key"}],"title":"APIKeyHeader"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"platform.json"},"subdomain":"ampersand-24eb5c1a","siteName":"Ampersand","title":"Update an installation object - Ampersand","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T04:53:30.441Z","originalFileLocation":"reference/installation/update-an-installation-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates a single object\u0026#x27;s configuration within an installation using JSON Patch syntax.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ampersand\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update an installation object - Ampersand\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a single object\u0026#x27;s configuration within an installation using JSON Patch syntax.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ampersand\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ampersand.ai/reference/installation/update-an-installation-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ampersand-24eb5c1a.mintlify.site/_mintlify/api/og/v2?division=Installation\u0026amp;title=Update+an+installation+object\u0026amp;description=Updates+a+single+object%27s+configuration+within+an+installation+using+JSON+Patch+syntax.%0A\u0026amp;theme=9c317003eb22ad486143ef26\u0026amp;signature=fb530b7c00d181b182c629e2f6227ea53248d93103857ec177416d2de15a9015\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update an installation object - Ampersand\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a single object\u0026#x27;s configuration within an installation using JSON Patch syntax.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ampersand-24eb5c1a.mintlify.site/_mintlify/api/og/v2?division=Installation\u0026amp;title=Update+an+installation+object\u0026amp;description=Updates+a+single+object%27s+configuration+within+an+installation+using+JSON+Patch+syntax.%0A\u0026amp;theme=9c317003eb22ad486143ef26\u0026amp;signature=fb530b7c00d181b182c629e2f6227ea53248d93103857ec177416d2de15a9015\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ampersand\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F71D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ampersand.ai/reference/installation/update-an-installation-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/installation/update-an-installation-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ampersand.ai/#organization\",\"name\":\"Ampersand\",\"url\":\"https://docs.ampersand.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/light.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=7799b7c055eff93e5275bfee4335494b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ampersand.ai#website\",\"name\":\"Ampersand\",\"url\":\"https://docs.ampersand.ai\",\"publisher\":{\"@id\":\"https://docs.ampersand.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object#webpage\",\"url\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object\",\"name\":\"Update an installation object\",\"description\":\"Updates a single object's configuration within an installation using JSON Patch syntax.\",\"dateModified\":\"2026-01-28T04:53:30.441Z\",\"isPartOf\":{\"@id\":\"https://docs.ampersand.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PLATFORM API\",\"item\":\"https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Installation\",\"item\":\"https://docs.ampersand.ai/reference/installation/list-installations-for-an-integration\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update an installation object\",\"item\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object#apireference\",\"headline\":\"Update an installation object\",\"name\":\"Update an installation object\",\"description\":\"Updates a single object's configuration within an installation using JSON Patch syntax.\",\"url\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ampersand.ai/reference/installation/update-an-installation-object#webpage\"},\"dateModified\":\"2026-01-28T04:53:30.441Z\",\"publisher\":{\"@id\":\"https://docs.ampersand.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ampersand.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ampersand\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ampersand\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/installation/update-an-installation-object.md","siteName":"Ampersand","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Ampersand REST APIs: Write, Read, Platform, and Proxy","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Access via API key","href":"/api/key-auth"},{"title":"Access via JWT","href":"/api/jwt-auth"}]},{"group":"WRITE API","pages":[{"group":"Write","pages":[{"openapi":"write post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}","title":"Write records","href":"/reference/write/write-records"}]}]},{"group":"READ API","pages":[{"group":"Read","pages":[{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}","title":"Trigger a read","href":"/reference/read/trigger-a-read"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause","title":"Pause reads for an installation","href":"/reference/read/pause-reads-for-an-installation"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:unpause","title":"Unpause reads for an installation","href":"/reference/read/unpause-reads-for-an-installation"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}:deliverResults","title":"Deliver results","href":"/reference/read/deliver-results"}]}]},{"group":"SEARCH API","pages":[{"group":"Search","pages":[{"openapi":"search post /projects/{projectIdOrName}/integrations/{integrationId}","title":"Search records","href":"/reference/search/search-records"}]}]},{"group":"PLATFORM API","pages":[{"group":"OAuth","pages":[{"openapi":"platform post /oauth-connect","title":"Generate OAuth authorization URL","href":"/reference/oauth/generate-oauth-authorization-url"},{"openapi":"platform patch /projects/{projectIdOrName}/connections/{connectionId}:oauth-update","title":"Generate OAuth authorization URL for existing connection","href":"/reference/oauth/generate-oauth-authorization-url-for-existing-connection"}]},{"group":"Connection","pages":[{"openapi":"platform post /custom-auth/connect","title":"Start or continue a multi-step custom auth flow","href":"/reference/connection/start-or-continue-a-multi-step-custom-auth-flow"},{"openapi":"platform get /projects/{projectIdOrName}/connections","title":"List connections","href":"/reference/connection/list-connections"},{"openapi":"platform post /projects/{projectIdOrName}/connections:generate","title":"Generate a new connection","href":"/reference/connection/generate-a-new-connection"},{"openapi":"platform get /projects/{projectIdOrName}/connections/{connectionId}","title":"Get a connection","href":"/reference/connection/get-a-connection"},{"openapi":"platform delete /projects/{projectIdOrName}/connections/{connectionId}","title":"Delete a connection","href":"/reference/connection/delete-a-connection"},{"openapi":"platform patch /projects/{projectIdOrName}/connections/{connectionId}","title":"Update a connection.","href":"/reference/connection/update-a-connection"}]},{"group":"Project","pages":[{"openapi":"platform get /projects","title":"List projects","href":"/reference/project/list-projects"},{"openapi":"platform post /projects","title":"Create a new project","href":"/reference/project/create-a-new-project"},{"openapi":"platform get /projects/{projectIdOrName}","title":"Get a project","href":"/reference/project/get-a-project"},{"openapi":"platform patch /projects/{projectIdOrName}","title":"Update a project","href":"/reference/project/update-a-project"}]},{"group":"Provider App","pages":[{"openapi":"platform get /projects/{projectIdOrName}/provider-apps","title":"List provider apps","href":"/reference/provider-app/list-provider-apps"},{"openapi":"platform post /projects/{projectIdOrName}/provider-apps","title":"Create a new provider app","href":"/reference/provider-app/create-a-new-provider-app"},{"openapi":"platform delete /projects/{projectIdOrName}/provider-apps/{providerAppId}","title":"Delete a provider app.","href":"/reference/provider-app/delete-a-provider-app"},{"openapi":"platform patch /projects/{projectIdOrName}/provider-apps/{providerAppId}","title":"Update a provider app","href":"/reference/provider-app/update-a-provider-app"}]},{"group":"Integration","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations","title":"List integrations","href":"/reference/integration/list-integrations"},{"openapi":"platform post /projects/{projectIdOrName}/integrations","title":"Create a new integration.","href":"/reference/integration/create-a-new-integration"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationIdOrName}","title":"Get an integration by ID or name","href":"/reference/integration/get-an-integration-by-id-or-name"},{"openapi":"platform delete /projects/{projectIdOrName}/integrations/{integrationIdOrName}","title":"Delete an integration","href":"/reference/integration/delete-an-integration"},{"openapi":"platform put /projects/{projectIdOrName}/integrations:batch","title":"Batch upsert a group of integrations","href":"/reference/integration/batch-upsert-a-group-of-integrations"}]},{"group":"Revision","pages":[{"openapi":"platform post /projects/{projectIdOrName}/integrations/{integrationId}/revisions","title":"Create a new revision.","href":"/reference/revision/create-a-new-revision"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/revisions/{revisionId}:hydrate","title":"Get a hydrated revision","href":"/reference/revision/get-a-hydrated-revision"}]},{"group":"Installation","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations","title":"List installations for an integration","href":"/reference/installation/list-installations-for-an-integration"},{"openapi":"platform post /projects/{projectIdOrName}/integrations/{integrationId}/installations","title":"Create a new installation","href":"/reference/installation/create-a-new-installation"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Get an installation","href":"/reference/installation/get-an-installation"},{"openapi":"platform delete /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Delete an installation","href":"/reference/installation/delete-an-installation"},{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Update an installation","description":"Update an installation using field masks. Note: subscribe config changes trigger a subscription change in the provider's system, which typically takes 1-2 minutes but may take up to 10 minutes.\n","href":"/reference/installation/update-an-installation"},{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/config-content","title":"Update an installation object","href":"/reference/installation/update-an-installation-object"},{"openapi":"platform get /projects/{projectIdOrName}/installations","title":"List installations for a project","description":"Lists all installations across every integration in a project, giving you a complete view of all active customer integrations. To narrow results to a single integration, use listInstallations instead.\n","href":"/reference/installation/list-installations-for-a-project"}]},{"group":"Objects \u0026 Fields","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/metadata","title":"Get object metadata via installation","href":"/reference/objects-\u0026-fields/get-object-metadata-via-installation"},{"openapi":"platform get /projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata","title":"Get object metadata via connection","href":"/reference/objects-\u0026-fields/get-object-metadata-via-connection"},{"openapi":"platform put /projects/{projectIdOrName}/integrations/{integrationId}/object-metadata","title":"Upsert custom fields for installation","href":"/reference/objects-\u0026-fields/upsert-custom-fields-for-installation"},{"openapi":"platform put /projects/{projectIdOrName}/providers/{provider}/object-metadata","title":"Upsert custom fields for connection","href":"/reference/objects-\u0026-fields/upsert-custom-fields-for-connection"}]},{"group":"Operation","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/operations","title":"List operations","href":"/reference/operation/list-operations"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/objects/{objectName}/backfill-progress","title":"Get backfill progress","href":"/reference/operation/get-backfill-progress"},{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}","title":"Get an operation","href":"/reference/operation/get-an-operation"},{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}/logs","title":"List logs for an operation","href":"/reference/operation/list-logs-for-an-operation"}]},{"group":"Provider","pages":[{"openapi":"platform get /providers","title":"List providers","href":"/reference/provider/list-providers"},{"openapi":"platform get /providers/{provider}","title":"Get provider","href":"/reference/provider/get-provider"}]},{"group":"API Key","pages":[{"openapi":"platform get /projects/{projectIdOrName}/api-keys","title":"List API keys","href":"/reference/api-key/list-api-keys"},{"openapi":"platform post /projects/{projectIdOrName}/api-keys","title":"Create a new API key","href":"/reference/api-key/create-a-new-api-key"},{"openapi":"platform get /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Get an API key","href":"/reference/api-key/get-an-api-key"},{"openapi":"platform delete /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Delete an API key","href":"/reference/api-key/delete-an-api-key"},{"openapi":"platform patch /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Update an API key","href":"/reference/api-key/update-an-api-key"}]},{"group":"Destination","pages":[{"openapi":"platform get /projects/{projectIdOrName}/destinations","title":"List destinations","href":"/reference/destination/list-destinations"},{"openapi":"platform post /projects/{projectIdOrName}/destinations","title":"Create a new destination","href":"/reference/destination/create-a-new-destination"},{"openapi":"platform get /projects/{projectIdOrName}/destinations/{destination}","title":"Get a destination","href":"/reference/destination/get-a-destination"},{"openapi":"platform delete /projects/{projectIdOrName}/destinations/{destination}","title":"Delete a destination","href":"/reference/destination/delete-a-destination"},{"openapi":"platform patch /projects/{projectIdOrName}/destinations/{destination}","title":"Update a destination","href":"/reference/destination/update-a-destination"},{"openapi":"platform get /projects/{projectIdOrName}/topics","title":"List topics","href":"/reference/destination/list-topics"},{"openapi":"platform post /projects/{projectIdOrName}/topics","title":"Create a topic","href":"/reference/destination/create-a-topic"},{"openapi":"platform delete /projects/{projectIdOrName}/topics/{topicId}","title":"Delete a topic","href":"/reference/destination/delete-a-topic"},{"openapi":"platform patch /projects/{projectIdOrName}/topics/{topicId}","title":"Update a topic","href":"/reference/destination/update-a-topic"},{"openapi":"platform get /projects/{projectIdOrName}/topic-destination-routes","title":"List topic destination routes","href":"/reference/destination/list-topic-destination-routes"},{"openapi":"platform post /projects/{projectIdOrName}/topic-destination-routes","title":"Create a topic destination route","href":"/reference/destination/create-a-topic-destination-route"},{"openapi":"platform delete /projects/{projectIdOrName}/topic-destination-routes/{routeId}","title":"Delete a topic destination route","href":"/reference/destination/delete-a-topic-destination-route"}]},{"group":"Upload URL","pages":[{"openapi":"platform get /generate-upload-url","title":"Generate a signed URL to upload a zip file to.","href":"/reference/upload-url/generate-a-signed-url-to-upload-a-zip-file-to"}]},{"group":"Org","pages":[{"openapi":"platform post /orgs","title":"Create a new organization","href":"/reference/org/create-a-new-organization"},{"openapi":"platform get /orgs/{orgId}","title":"Get an organization","href":"/reference/org/get-an-organization"},{"openapi":"platform patch /orgs/{orgId}","title":"Update an organization","href":"/reference/org/update-an-organization"},{"openapi":"platform get /orgs/{orgId}/builders","title":"List builders for an organization","href":"/reference/org/list-builders-for-an-organization"},{"openapi":"platform get /orgs/{orgId}/invites","title":"List invites for an organization","href":"/reference/org/list-invites-for-an-organization"},{"openapi":"platform post /orgs/{orgId}/invites","title":"Invite a user to an organization","href":"/reference/org/invite-a-user-to-an-organization"},{"openapi":"platform get /orgs/{orgId}/invites/{inviteId}","title":"Get an invite","href":"/reference/org/get-an-invite"},{"openapi":"platform delete /orgs/{orgId}/invites/{inviteId}","title":"Revoke an invite","href":"/reference/org/revoke-an-invite"},{"openapi":"platform post /orgs/{orgId}/memberships","title":"Add user to an organization","href":"/reference/org/add-user-to-an-organization"},{"openapi":"platform get /claimed-domains","title":"Check if a domain is claimed","href":"/reference/org/check-if-a-domain-is-claimed"},{"openapi":"platform post /claimed-domains","title":"Claim a domain","href":"/reference/org/claim-a-domain"},{"openapi":"platform get /orgs/{orgId}/claimed-domains","title":"List organization's claimed domains","href":"/reference/org/list-organizations-claimed-domains"}]},{"group":"User","pages":[{"openapi":"platform get /my-info","title":"Get information about the current user","href":"/reference/user/get-information-about-the-current-user"},{"openapi":"platform post /invites:accept","title":"Accept an invite","href":"/reference/user/accept-an-invite"}]},{"group":"Billing Account","pages":[{"openapi":"platform get /orgs/{orgId}/billingAccount","title":"Get the billing account for an organization","href":"/reference/billing-account/get-the-billing-account-for-an-organization"},{"openapi":"platform post /billingAccounts/{billingAccountId}/portalSession","title":"Create a portal session for a billing account","href":"/reference/billing-account/create-a-portal-session-for-a-billing-account"}]},{"group":"Notification","pages":[{"openapi":"platform get /projects/{projectIdOrName}/notification-event-topic-routes","title":"List notification event-topic routes","href":"/reference/notification/list-notification-event-topic-routes"},{"openapi":"platform post /projects/{projectIdOrName}/notification-event-topic-routes","title":"Create a notification event-topic route","href":"/reference/notification/create-a-notification-event-topic-route"},{"openapi":"platform delete /projects/{projectIdOrName}/notification-event-topic-routes/{routeId}","title":"Delete a notification event-topic route","href":"/reference/notification/delete-a-notification-event-topic-route"}]},{"group":"JWT Key","pages":[{"openapi":"platform get /projects/{projectIdOrName}/jwt-keys","title":"List JWT keys","href":"/reference/jwt-key/list-jwt-keys"},{"openapi":"platform post /projects/{projectIdOrName}/jwt-keys","title":"Create a new JWT key","href":"/reference/jwt-key/create-a-new-jwt-key"},{"openapi":"platform get /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Get a specific JWT key","href":"/reference/jwt-key/get-a-specific-jwt-key"},{"openapi":"platform delete /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Delete a JWT key","href":"/reference/jwt-key/delete-a-jwt-key"},{"openapi":"platform patch /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Update a JWT key","href":"/reference/jwt-key/update-a-jwt-key"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/provider-guides/overview"}]},{"tab":"Troubleshooting","pages":[{"title":"Troubleshooting","href":"/troubleshooting-guides/overview"}]}]},"basePath":"","title":"Update an installation object - Ampersand","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}