Updates a connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values. action_config, event_config, sync_config and sync_event_subscriptions each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send null, to leave it unchanged.
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
id
string
required
The unique identifier of the connector profile.
Query Parameters
expand
string | null
A comma-separated list of additional fields to expand. Supported values: connector (the connector this profile configures), version (the connector version this profile resolves to), accounts_count (the number of accounts linked to this profile), callback_url (the OAuth callback URL the provider app must allow for this profile) and enabled_actions_count (how many of that version's actions this profile enables). These are returned as null unless requested.
Example:
"connector,version"
Body
application/json
name
string | null
The display name of the connector profile.
authentication_config_key
string | null
The key of the connector's authentication configuration to use. Switching it usually requires resending the setup fields and secrets of the new method.
environment
string | null
The environment of the authentication configuration (e.g. production).
active
boolean | null
Whether the connector profile is active.
is_default
boolean | null
Whether this is the connector's default profile. Marking a profile as default demotes the previous one. false is ignored when the profile ends the request active and no other profile is the default. A disabled profile cannot be made the default: send active: true in the same request, or the request is refused with connector_profile_disabled_cannot_be_default. Resending true to a disabled profile that is already the only default is accepted and changes nothing. Any save that leaves a profile disabled while another profile is also the default clears this flag on it, even when is_default is omitted.
version
string | null
The connector version the profile uses.
pinned_version
string | null
The connector version to pin the profile to. Only applies to Falcon-versioned connectors; ignored otherwise.
owner
string | null
The owner of the pinned connector version (defaults to stackone). Accepts the wildcards builtin (the global stackone owner) and custom (the organization's own connectors).
setup_fields
object | null
The non-secret setup field values, keyed by setup field key. Replaces the saved setup fields when provided.
secrets
object | null
The secret field values, keyed by field key. Replaces the saved secrets when provided: resend a __secretvalue:-prefixed placeholder to keep a stored secret, send an empty object to clear all secrets, or omit the field to leave them unchanged.
action_config
object | null
The per-action enablement of the profile, keyed by action id. Sending it replaces the stored map, so an entry left out is removed. Omit it, or send null, to leave the enabled actions unchanged.
Show child attributes
event_config
object | null
The events the profile processes and the webhooks they are delivered to, keyed by event action id: the id of an entry in event_actions from GET /v2/connectors/{id}?expand=actions (e.g. deel_webhook_employee_created_direct). Each entry sets whether the event action is enabled and, in webhook_ids, which webhooks receive its events. An event action left out is disabled. A webhook id that does not belong to the project fails the request with a 400. Keys are not checked against the connector, so an unknown event action id is stored but never matches an event. Sending it replaces the stored configuration in full, so an event action left out also loses its webhooks. Omit it, or send null, to leave the event configuration unchanged; send {} to disable every event action and remove all its webhook subscriptions.
The per-action data-sync configuration, keyed by action id. Sending it replaces the stored map, so an action left out stops syncing. Omit it, or send null, to leave the sync configuration unchanged.
Show child attributes
callback_domain
string | null
The hostname of one of the organization's active custom domains (e.g. auth.example.com) that the OAuth callback is served on, in place of StackOne's API host. Omit it to leave the domain unchanged, or send null to go back to StackOne's default. Changing it, including to or from null, requires a project or organization admin, otherwise the request is refused with callback_domain_admin_required; resending the saved value is not a change. Setting a hostname also requires custom domains to be enabled for the organization, otherwise the request is refused with callback_domain_not_enabled_for_organization; going back to null does not. A hostname that is not an active custom domain of the organization is refused with callback_domain_not_available.
Example:
"auth.example.com"
sync_event_subscriptions
object | null
The webhooks notified of the record changes each sync finds, keyed by the action id of a sync in sync_config. Each action must have a sync, enabled or not, and each webhook must belong to the project; otherwise the request is refused with sync_event_subscriptions_invalid or sync_event_subscription_webhook_not_found. A webhook may appear once per action. The sync is checked in sync_config when this request sends it, otherwise in the stored configuration. Sending it replaces the stored subscriptions in full, so a webhook left out stops being notified; a webhook kept on an action keeps its baseline. Omit it, or send null, to leave them unchanged; send {} to remove them all. Removing an action from sync_config also removes its subscriptions.
The connector key (e.g. workday). Always present; the full connector object requires ?expand=connector.
connector
object | null
required
The connector this profile configures. Always present; null unless requested via ?expand=connector.
Show child attributes
version
object | null
required
The connector version this profile resolves to. Always present; null unless requested via ?expand=version.
Show child attributes
accounts_count
integer | null
required
The number of accounts linked to this connector profile that are visible to you. Always present; null unless requested via ?expand=accounts_count.
enabled_actions_count
integer | null
required
How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. 0 when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; null unless requested via ?expand=enabled_actions_count on a read endpoint, and always null on create.
active
boolean
required
Whether the connector profile is active.
default
boolean
required
Whether this is the default connector profile.
environment
string | null
required
The environment of the connector profile.
authentication_config_key
string | null
required
The authentication configuration key.
callback_domain
string | null
required
The hostname of the organization's custom domain the OAuth callback is served on. null when the profile uses StackOne's default.
Example:
"auth.example.com"
callback_url
string | null
required
The OAuth or OIDC callback URL to allow in the provider app for this profile. With a callback_domain it is always https://<callback_domain>/connect/oauth2/<connector_key>/callback. Without one it is the redirectUri set in the setup fields or declared by the connector, otherwise the standard callback path on StackOne's API host. null when the authentication configuration is neither OAuth 2.0 nor OIDC. Always present; null unless requested via ?expand=callback_url.
The timestamp when the connector profile was created.
updated_at
string<date-time>
required
The timestamp when the connector profile was last updated.
setup_fields
object
required
The saved non-secret setup field values, keyed by setup field key.
secrets
object
required
The saved secret fields, keyed by field key. Values are __secretvalue:-prefixed redacted placeholders (never the plaintext); resend a placeholder unchanged to keep the stored secret.
Show child attributes
action_config
object
required
The per-action enablement of the profile, keyed by action id.
Show child attributes
event_config
object
required
The saved event action configuration and the webhooks subscribed to each event action, keyed by event action id. Set it with event_config on create or patch.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Stackone","colors":{"primary":"#068F56","light":"#00AF66","dark":"#068F56"},"logo":{"light":"https://mintcdn.com/stackone-60/WsmKpuoeBZmio9QO/images/logo/logo-light-mode.svg?fit=max\u0026auto=format\u0026n=WsmKpuoeBZmio9QO\u0026q=85\u0026s=f08be9c0a142cb1e7fcaa23910c4bf7f","dark":"https://mintcdn.com/stackone-60/WsmKpuoeBZmio9QO/images/logo/logo-dark-mode.svg?fit=max\u0026auto=format\u0026n=WsmKpuoeBZmio9QO\u0026q=85\u0026s=b57d63594c13dee65c06a2d578927466","href":"/introduction"},"favicon":"https://mintcdn.com/stackone-60/EZ7nWzE-JJzhmP-C/images/logo/favicon.png?fit=max\u0026auto=format\u0026n=EZ7nWzE-JJzhmP-C\u0026q=85\u0026s=9012a8ae6ce9a80698406b611be47925","appearance":{"default":"light"},"background":{"image":{"light":"https://mintcdn.com/stackone-60/knwbcGlYFJSeLObv/images/background/light.svg?fit=max\u0026auto=format\u0026n=knwbcGlYFJSeLObv\u0026q=85\u0026s=112166d244e990ebc0146ff96958757c","dark":"https://mintcdn.com/stackone-60/knwbcGlYFJSeLObv/images/background/dark.svg?fit=max\u0026auto=format\u0026n=knwbcGlYFJSeLObv\u0026q=85\u0026s=50ec5e23eeb91f55e78a0da97dcaeb7b"},"color":{"dark":"#1a1a1a"}},"navbar":{"links":[{"icon":"circle-question","href":"/support","label":"Support"},{"href":"https://app.stackone.com","label":"Login"},{"href":"https://www.stackone.com/demo/","label":"Book a demo"}],"primary":{"type":"button","label":"Start Free","href":"https://app.stackone.com/sign_up"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/stackonehq","twitter":"https://twitter.com/StackOneHQ"}},"seo":{"metatags":{"canonical":"https://docs.stackone.com","google-site-verification":"gYj1x4gkdSwpCGVLFVXNVOPQ_wVrePW37ZKJt3HEqys"}},"fonts":{"heading":{"family":"Sf Pro Display","source":"https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2","format":"woff2"},"body":{"family":"Inter","source":"https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-NZNK37TL"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stackone-60","hasAudioNarration":false,"actualSubdomain":"stackone-60","customDomains":["docs.stackone.com"],"gitSource":{"type":"github","owner":"stackonehq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afad23a3f5f5eede31cdca1","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Connectors","count":6773},{"language":"default","tag":"Connector Catalog","count":3365},{"language":"default","tag":"Embed","count":84},{"language":"default","tag":"Platform API","count":65},{"language":"default","tag":"Features","count":48},{"language":"default","tag":"Connector Building","count":42},{"language":"default","tag":"AI Platforms","count":39},{"language":"default","tag":"Gateway","count":39},{"language":"default","tag":"Unified Actions","count":39},{"language":"default","tag":"Embed StackOne","count":36}],"searchSettings":{"isFiltersEnabled":true}},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@stackone.com"}},"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":"style.css","href":"/_mintlify/custom/stackone-60/1689b391b56fc5fb/style.css"}],"page":{"pagePath":"platform/api-reference/v2/connector-profiles/patch-a-connector-profile","slug":"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile","pageMetadata":{"openapi":"patch /v2/connector_profiles/{id}","title":"Patch a connector profile","description":"Updates a connector profile. Secrets resent as `__secretvalue:`-prefixed placeholders keep their stored values. `action_config`, `event_config`, `sync_config` and `sync_event_subscriptions` each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send `null`, to leave it unchanged.","href":"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Updates a connector profile. Secrets resent as \", _jsx(_components.code, {\n children: \"__secretvalue:\"\n }), \"-prefixed placeholders keep their stored values. \", _jsx(_components.code, {\n children: \"action_config\"\n }), \", \", _jsx(_components.code, {\n children: \"event_config\"\n }), \", \", _jsx(_components.code, {\n children: \"sync_config\"\n }), \" and \", _jsx(_components.code, {\n children: \"sync_event_subscriptions\"\n }), \" each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send \", _jsx(_components.code, {\n children: \"null\"\n }), \", to leave it unchanged.\"]\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":{"config":{},"pageMetadata":{"openapi":"patch /v2/connector_profiles/{id}","title":"Patch a connector profile","description":"Updates a connector profile. Secrets resent as `__secretvalue:`-prefixed placeholders keep their stored values. `action_config`, `event_config`, `sync_config` and `sync_event_subscriptions` each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send `null`, to leave it unchanged.","href":"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/stackone-60/072d59ca3ea476f6/status-indicator.js","/_mintlify/custom/stackone-60/108e4b0e256a9ba7/connectors.js","/_mintlify/custom/stackone-60/af28b3fbb0435529/hubspot-form.js","/_mintlify/custom/stackone-60/965ecce887247b53/end-users.js"],"openApiReferenceData":{"operation":{"description":"Updates a connector profile. Secrets resent as `__secretvalue:`-prefixed placeholders keep their stored values. `action_config`, `event_config`, `sync_config` and `sync_event_subscriptions` each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send `null`, to leave it unchanged.","operationId":"patch_connector_profile","parameters":["efef4518-9cb7-4f42-9f66-f887b7fdaa34","06a84756-4caf-4459-9143-1b017b8126a6"],"requestBody":"9d86d13a-e97a-405b-919e-3a2eb5e3d9aa","responses":{"200":"48add4f0-1714-4fd9-9673-7aba59ea02e5","400":"a9fb83c6-5f42-4024-86a4-2bebc0fd2775","401":"94e7fe46-b03f-4e6e-b588-9070f7f7ef53","403":"970cf946-93f9-4f02-a5be-adaa26d4b8c5","404":"0febe48f-f61d-452e-b5cf-4702196c15ac","408":"68d57a35-ba0f-431d-909c-9c47888db947","409":"55eaf46f-6fb8-497b-93d4-76044862b880","422":"97a7805b-ce0c-4cc5-add2-f2051b638295","429":"634e8efe-0841-4c14-8454-6662dc2bdb76","500":"3b32540b-855f-4d6c-92e5-11dbba81bd8e","501":"4557d721-b8ab-44e1-90d0-787bcb616403","502":"179621cd-f3ea-434b-9b2c-7d468d7b2ee0"},"security":["bec24dc0-b381-415d-9117-6163a7f935a4"],"summary":"Patch a connector profile","tags":["Connector Profiles"],"method":"patch","type":"path","servers":["bb7cb5c7-4e06-477b-b1ef-1d5d4ba46c54"],"path":"/v2/connector_profiles/{id}","baseUrlOptions":["https://api.stackone.com"],"title":"Patch a connector profile","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"efef4518-9cb7-4f42-9f66-f887b7fdaa34":{"name":"id","required":true,"in":"path","description":"The unique identifier of the connector profile.","schema":{"type":"string","isRequired":true,"description":"The unique identifier of the connector profile.","uniqueKey":"","typeLabel":"string"}},"06a84756-4caf-4459-9143-1b017b8126a6":{"name":"expand","required":false,"in":"query","description":"A comma-separated list of additional fields to expand. Supported values: `connector` (the connector this profile configures), `version` (the connector version this profile resolves to), `accounts_count` (the number of accounts linked to this profile), `callback_url` (the OAuth callback URL the provider app must allow for this profile) and `enabled_actions_count` (how many of that version's actions this profile enables). These are returned as `null` unless requested.","schema":{"oneOf":[{"example":"connector,version","type":"string","description":"A comma-separated list of additional fields to expand. Supported values: `connector` (the connector this profile configures), `version` (the connector version this profile resolves to), `accounts_count` (the number of accounts linked to this profile), `callback_url` (the OAuth callback URL the provider app must allow for this profile) and `enabled_actions_count` (how many of that version's actions this profile enables). These are returned as `null` unless requested.","uniqueKey":"oneOf.0","typeLabel":"string"},{"example":"connector,version","type":"null","description":"A comma-separated list of additional fields to expand. Supported values: `connector` (the connector this profile configures), `version` (the connector version this profile resolves to), `accounts_count` (the number of accounts linked to this profile), `callback_url` (the OAuth callback URL the provider app must allow for this profile) and `enabled_actions_count` (how many of that version's actions this profile enables). These are returned as `null` unless requested.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The display name of the connector profile.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name of the connector profile.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"authentication_config_key":{"oneOf":[{"type":"string","description":"The key of the connector's authentication configuration to use. Switching it usually requires resending the setup fields and secrets of the new method.","uniqueKey":"authentication_config_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key of the connector's authentication configuration to use. Switching it usually requires resending the setup fields and secrets of the new method.","uniqueKey":"authentication_config_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_config_key","typeLabel":"string | null"},"environment":{"oneOf":[{"type":"string","description":"The environment of the authentication configuration (e.g. `production`).","uniqueKey":"environment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The environment of the authentication configuration (e.g. `production`).","uniqueKey":"environment.oneOf.1","typeLabel":"null"}],"uniqueKey":"environment","typeLabel":"string | null"},"active":{"oneOf":[{"type":"boolean","description":"Whether the connector profile is active.","uniqueKey":"active.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the connector profile is active.","uniqueKey":"active.oneOf.1","typeLabel":"null"}],"uniqueKey":"active","typeLabel":"boolean | null"},"is_default":{"oneOf":[{"type":"boolean","description":"Whether this is the connector's default profile. Marking a profile as default demotes the previous one. `false` is ignored when the profile ends the request active and no other profile is the default. A disabled profile cannot be made the default: send `active: true` in the same request, or the request is refused with `connector_profile_disabled_cannot_be_default`. Resending `true` to a disabled profile that is already the only default is accepted and changes nothing. Any save that leaves a profile disabled while another profile is also the default clears this flag on it, even when `is_default` is omitted.","uniqueKey":"is_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether this is the connector's default profile. Marking a profile as default demotes the previous one. `false` is ignored when the profile ends the request active and no other profile is the default. A disabled profile cannot be made the default: send `active: true` in the same request, or the request is refused with `connector_profile_disabled_cannot_be_default`. Resending `true` to a disabled profile that is already the only default is accepted and changes nothing. Any save that leaves a profile disabled while another profile is also the default clears this flag on it, even when `is_default` is omitted.","uniqueKey":"is_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_default","typeLabel":"boolean | null"},"version":{"oneOf":[{"type":"string","description":"The connector version the profile uses.","uniqueKey":"version.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector version the profile uses.","uniqueKey":"version.oneOf.1","typeLabel":"null"}],"uniqueKey":"version","typeLabel":"string | null"},"pinned_version":{"oneOf":[{"type":"string","description":"The connector version to pin the profile to. Only applies to Falcon-versioned connectors; ignored otherwise.","uniqueKey":"pinned_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector version to pin the profile to. Only applies to Falcon-versioned connectors; ignored otherwise.","uniqueKey":"pinned_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"pinned_version","typeLabel":"string | null"},"owner":{"oneOf":[{"type":"string","description":"The owner of the pinned connector version (defaults to `stackone`). Accepts the wildcards `builtin` (the global `stackone` owner) and `custom` (the organization's own connectors).","uniqueKey":"owner.oneOf.0","typeLabel":"string"},{"type":"null","description":"The owner of the pinned connector version (defaults to `stackone`). Accepts the wildcards `builtin` (the global `stackone` owner) and `custom` (the organization's own connectors).","uniqueKey":"owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner","typeLabel":"string | null"},"setup_fields":{"oneOf":[{"type":"object","additionalProperties":true,"description":"The non-secret setup field values, keyed by setup field key. Replaces the saved setup fields when provided.","uniqueKey":"setup_fields.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"The non-secret setup field values, keyed by setup field key. Replaces the saved setup fields when provided.","uniqueKey":"setup_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"setup_fields","typeLabel":"object | null"},"secrets":{"oneOf":[{"type":"object","additionalProperties":true,"description":"The secret field values, keyed by field key. Replaces the saved secrets when provided: resend a `__secretvalue:`-prefixed placeholder to keep a stored secret, send an empty object to clear all secrets, or omit the field to leave them unchanged.","uniqueKey":"secrets.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"The secret field values, keyed by field key. Replaces the saved secrets when provided: resend a `__secretvalue:`-prefixed placeholder to keep a stored secret, send an empty object to clear all secrets, or omit the field to leave them unchanged.","uniqueKey":"secrets.oneOf.1","typeLabel":"null"}],"uniqueKey":"secrets","typeLabel":"object | null"},"action_config":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"action_config.oneOf.0.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"action_config.oneOf.0.additionalProperties","typeLabel":"object"},"description":"The per-action enablement of the profile, keyed by action id. Sending it replaces the stored map, so an entry left out is removed. Omit it, or send `null`, to leave the enabled actions unchanged.","uniqueKey":"action_config.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","uniqueKey":"action_config.oneOf.1.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"action_config.oneOf.1.additionalProperties","typeLabel":"object"},"description":"The per-action enablement of the profile, keyed by action id. Sending it replaces the stored map, so an entry left out is removed. Omit it, or send `null`, to leave the enabled actions unchanged.","uniqueKey":"action_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_config","typeLabel":"object | null"},"event_config":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the profile processes this event action. Provider events for an event action that is disabled, or missing from `event_config`, are dropped and reach no webhook.","isRequired":true,"uniqueKey":"event_config.oneOf.0.additionalProperties.enabled","typeLabel":"boolean"},"webhook_ids":{"type":"array","items":{"type":"string","example":"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13","uniqueKey":"event_config.oneOf.0.additionalProperties.webhook_ids.items.[INDEX]","typeLabel":"string"},"description":"Webhook ids, not URLs: the `id` of each webhook as returned by `GET /v2/webhooks`. These webhooks receive the event action's events for every account linked to the profile. Each must belong to the project; a webhook that is not active receives nothing until it is enabled again. Send an empty list to process the event action without delivering it to a webhook.","isRequired":true,"uniqueKey":"event_config.oneOf.0.additionalProperties.webhook_ids","typeLabel":"string[]"}},"required":["enabled","webhook_ids"],"uniqueKey":"event_config.oneOf.0.additionalProperties","typeLabel":"object"},"example":{"deel_webhook_employee_created_direct":{"enabled":true,"webhook_ids":["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]},"deel_webhook_employee_updated_direct":{"enabled":false,"webhook_ids":[]}},"description":"The events the profile processes and the webhooks they are delivered to, keyed by event action id: the `id` of an entry in `event_actions` from `GET /v2/connectors/{id}?expand=actions` (e.g. `deel_webhook_employee_created_direct`). Each entry sets whether the event action is enabled and, in `webhook_ids`, which webhooks receive its events. An event action left out is disabled. A webhook id that does not belong to the project fails the request with a 400. Keys are not checked against the connector, so an unknown event action id is stored but never matches an event. Sending it replaces the stored configuration in full, so an event action left out also loses its webhooks. Omit it, or send `null`, to leave the event configuration unchanged; send `{}` to disable every event action and remove all its webhook subscriptions.","uniqueKey":"event_config.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the profile processes this event action. Provider events for an event action that is disabled, or missing from `event_config`, are dropped and reach no webhook.","uniqueKey":"event_config.oneOf.1.additionalProperties.enabled","typeLabel":"boolean"},"webhook_ids":{"type":"array","items":{"type":"string","example":"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13","uniqueKey":"event_config.oneOf.1.additionalProperties.webhook_ids.items.[INDEX]","typeLabel":"string"},"description":"Webhook ids, not URLs: the `id` of each webhook as returned by `GET /v2/webhooks`. These webhooks receive the event action's events for every account linked to the profile. Each must belong to the project; a webhook that is not active receives nothing until it is enabled again. Send an empty list to process the event action without delivering it to a webhook.","uniqueKey":"event_config.oneOf.1.additionalProperties.webhook_ids","typeLabel":"string[]"}},"required":["enabled","webhook_ids"],"uniqueKey":"event_config.oneOf.1.additionalProperties","typeLabel":"object"},"example":{"deel_webhook_employee_created_direct":{"enabled":true,"webhook_ids":["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]},"deel_webhook_employee_updated_direct":{"enabled":false,"webhook_ids":[]}},"description":"The events the profile processes and the webhooks they are delivered to, keyed by event action id: the `id` of an entry in `event_actions` from `GET /v2/connectors/{id}?expand=actions` (e.g. `deel_webhook_employee_created_direct`). Each entry sets whether the event action is enabled and, in `webhook_ids`, which webhooks receive its events. An event action left out is disabled. A webhook id that does not belong to the project fails the request with a 400. Keys are not checked against the connector, so an unknown event action id is stored but never matches an event. Sending it replaces the stored configuration in full, so an event action left out also loses its webhooks. Omit it, or send `null`, to leave the event configuration unchanged; send `{}` to disable every event action and remove all its webhook subscriptions.","uniqueKey":"event_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"event_config","typeLabel":"object | null"},"sync_config":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"sync_config.oneOf.0.additionalProperties.enabled","typeLabel":"boolean"},"cadence":{"type":"string","isRequired":true,"uniqueKey":"sync_config.oneOf.0.additionalProperties.cadence","typeLabel":"string"},"full_sync_after":{"type":"string","isRequired":true,"uniqueKey":"sync_config.oneOf.0.additionalProperties.full_sync_after","typeLabel":"string"},"start_at":{"type":"string","uniqueKey":"sync_config.oneOf.0.additionalProperties.start_at","typeLabel":"string"},"lookback_start":{"oneOf":[{"type":"string","format":"date","description":"The earliest record date sent to the provider on every run. ISO 8601 date, stored as midnight UTC; `null` turns lookback off. Omit it to keep the stored value, or on a new action to apply the connector default window. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events.","uniqueKey":"sync_config.oneOf.0.additionalProperties.lookback_start.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The earliest record date sent to the provider on every run. ISO 8601 date, stored as midnight UTC; `null` turns lookback off. Omit it to keep the stored value, or on a new action to apply the connector default window. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events.","uniqueKey":"sync_config.oneOf.0.additionalProperties.lookback_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_config.oneOf.0.additionalProperties.lookback_start","typeLabel":"string\u003cdate> | null"},"verify_deletions":{"type":"boolean","description":"Whether a full sync checks each record missing from the listing with the provider before reporting it removed. Omit it to keep the stored value; a new action starts with it off. Only accepted as `true` for an action that supports deletion verification. Each check is one extra action call.","uniqueKey":"sync_config.oneOf.0.additionalProperties.verify_deletions","typeLabel":"boolean"},"auto_link":{"type":"boolean","description":"Whether the action syncs automatically on every account linked to this profile. When a save enables an action with no required parameters, omitting it means `true` and `false` is refused; a stored value not saved since may still read `false`. An action with required parameters cannot be newly synced or auto-linked.","uniqueKey":"sync_config.oneOf.0.additionalProperties.auto_link","typeLabel":"boolean"}},"required":["enabled","cadence","full_sync_after"],"uniqueKey":"sync_config.oneOf.0.additionalProperties","typeLabel":"object"},"description":"The per-action data-sync configuration, keyed by action id. Sending it replaces the stored map, so an action left out stops syncing. Omit it, or send `null`, to leave the sync configuration unchanged.","uniqueKey":"sync_config.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","uniqueKey":"sync_config.oneOf.1.additionalProperties.enabled","typeLabel":"boolean"},"cadence":{"type":"string","uniqueKey":"sync_config.oneOf.1.additionalProperties.cadence","typeLabel":"string"},"start_at":{"type":"string","uniqueKey":"sync_config.oneOf.1.additionalProperties.start_at","typeLabel":"string"},"full_sync_after":{"type":"string","uniqueKey":"sync_config.oneOf.1.additionalProperties.full_sync_after","typeLabel":"string"},"lookback_start":{"oneOf":[{"type":"string","format":"date","description":"The earliest record date sent to the provider on every run. ISO 8601 date, stored as midnight UTC; `null` turns lookback off. Omit it to keep the stored value, or on a new action to apply the connector default window. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events.","uniqueKey":"sync_config.oneOf.1.additionalProperties.lookback_start.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The earliest record date sent to the provider on every run. ISO 8601 date, stored as midnight UTC; `null` turns lookback off. Omit it to keep the stored value, or on a new action to apply the connector default window. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events.","uniqueKey":"sync_config.oneOf.1.additionalProperties.lookback_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_config.oneOf.1.additionalProperties.lookback_start","typeLabel":"string\u003cdate> | null"},"verify_deletions":{"type":"boolean","description":"Whether a full sync checks each record missing from the listing with the provider before reporting it removed. Omit it to keep the stored value; a new action starts with it off. Only accepted as `true` for an action that supports deletion verification. Each check is one extra action call.","uniqueKey":"sync_config.oneOf.1.additionalProperties.verify_deletions","typeLabel":"boolean"},"auto_link":{"type":"boolean","description":"Whether the action syncs automatically on every account linked to this profile. When a save enables an action with no required parameters, omitting it means `true` and `false` is refused; a stored value not saved since may still read `false`. An action with required parameters cannot be newly synced or auto-linked.","uniqueKey":"sync_config.oneOf.1.additionalProperties.auto_link","typeLabel":"boolean"}},"required":["enabled","cadence","full_sync_after"],"uniqueKey":"sync_config.oneOf.1.additionalProperties","typeLabel":"object"},"description":"The per-action data-sync configuration, keyed by action id. Sending it replaces the stored map, so an action left out stops syncing. Omit it, or send `null`, to leave the sync configuration unchanged.","uniqueKey":"sync_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_config","typeLabel":"object | null"},"callback_domain":{"oneOf":[{"type":"string","description":"The hostname of one of the organization's active custom domains (e.g. `auth.example.com`) that the OAuth callback is served on, in place of StackOne's API host. Omit it to leave the domain unchanged, or send `null` to go back to StackOne's default. Changing it, including to or from `null`, requires a project or organization admin, otherwise the request is refused with `callback_domain_admin_required`; resending the saved value is not a change. Setting a hostname also requires custom domains to be enabled for the organization, otherwise the request is refused with `callback_domain_not_enabled_for_organization`; going back to `null` does not. A hostname that is not an active custom domain of the organization is refused with `callback_domain_not_available`.","example":"auth.example.com","uniqueKey":"callback_domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The hostname of one of the organization's active custom domains (e.g. `auth.example.com`) that the OAuth callback is served on, in place of StackOne's API host. Omit it to leave the domain unchanged, or send `null` to go back to StackOne's default. Changing it, including to or from `null`, requires a project or organization admin, otherwise the request is refused with `callback_domain_admin_required`; resending the saved value is not a change. Setting a hostname also requires custom domains to be enabled for the organization, otherwise the request is refused with `callback_domain_not_enabled_for_organization`; going back to `null` does not. A hostname that is not an active custom domain of the organization is refused with `callback_domain_not_available`.","example":"auth.example.com","uniqueKey":"callback_domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"callback_domain","typeLabel":"string | null"},"sync_event_subscriptions":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"webhook_id":{"type":"string","description":"The webhook the events are delivered to.","example":"wh_2b8d1f9a","minLength":1,"isRequired":true,"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX].webhook_id","typeLabel":"string"},"change_types":{"type":"array","minItems":1,"description":"The record changes the subscription is notified about.","example":["added","updated","removed"],"items":{"type":"string","enum":["added","updated","removed"],"description":"The record changes the subscription is notified about.","uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX].change_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX].change_types","typeLabel":"enum\u003cstring>[]"},"enabled":{"oneOf":[{"type":"boolean","description":"Whether the subscription delivers events.","default":true,"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX].enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the subscription delivers events.","default":true,"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX].enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX].enabled","typeLabel":"boolean | null"}},"required":["webhook_id","change_types"],"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sync_event_subscriptions.oneOf.0.additionalProperties","typeLabel":"object[]"},"example":{"list_employees":[{"webhook_id":"wh_2b8d1f9a","change_types":["added","updated","removed"]}]},"description":"The webhooks notified of the record changes each sync finds, keyed by the action id of a sync in `sync_config`. Each action must have a sync, enabled or not, and each webhook must belong to the project; otherwise the request is refused with `sync_event_subscriptions_invalid` or `sync_event_subscription_webhook_not_found`. A webhook may appear once per action. The sync is checked in `sync_config` when this request sends it, otherwise in the stored configuration. Sending it replaces the stored subscriptions in full, so a webhook left out stops being notified; a webhook kept on an action keeps its baseline. Omit it, or send `null`, to leave them unchanged; send `{}` to remove them all. Removing an action from `sync_config` also removes its subscriptions.","uniqueKey":"sync_event_subscriptions.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"object","properties":{"webhook_id":{"type":"string","description":"The webhook the events are delivered to.","example":"wh_2b8d1f9a","minLength":1,"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX].webhook_id","typeLabel":"string"},"change_types":{"type":"array","minItems":1,"description":"The record changes the subscription is notified about.","example":["added","updated","removed"],"items":{"type":"string","enum":["added","updated","removed"],"description":"The record changes the subscription is notified about.","uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX].change_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX].change_types","typeLabel":"enum\u003cstring>[]"},"enabled":{"oneOf":[{"type":"boolean","description":"Whether the subscription delivers events.","default":true,"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX].enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the subscription delivers events.","default":true,"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX].enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX].enabled","typeLabel":"boolean | null"}},"required":["webhook_id","change_types"],"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sync_event_subscriptions.oneOf.1.additionalProperties","typeLabel":"object[]"},"example":{"list_employees":[{"webhook_id":"wh_2b8d1f9a","change_types":["added","updated","removed"]}]},"description":"The webhooks notified of the record changes each sync finds, keyed by the action id of a sync in `sync_config`. Each action must have a sync, enabled or not, and each webhook must belong to the project; otherwise the request is refused with `sync_event_subscriptions_invalid` or `sync_event_subscription_webhook_not_found`. A webhook may appear once per action. The sync is checked in `sync_config` when this request sends it, otherwise in the stored configuration. Sending it replaces the stored subscriptions in full, so a webhook left out stops being notified; a webhook kept on an action keeps its baseline. Omit it, or send `null`, to leave them unchanged; send `{}` to remove them all. Removing an action from `sync_config` also removes its subscriptions.","uniqueKey":"sync_event_subscriptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_event_subscriptions","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","authentication_config_key":"\u003cstring>","environment":"\u003cstring>","active":true,"is_default":true,"version":"\u003cstring>","pinned_version":"\u003cstring>","owner":"\u003cstring>","setup_fields":{},"secrets":{},"action_config":{},"event_config":{"deel_webhook_employee_created_direct":{"enabled":true,"webhook_ids":["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]},"deel_webhook_employee_updated_direct":{"enabled":false,"webhook_ids":[]}},"sync_config":{},"callback_domain":"auth.example.com","sync_event_subscriptions":{"list_employees":[{"webhook_id":"wh_2b8d1f9a","change_types":["added","updated","removed"]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"48add4f0-1714-4fd9-9673-7aba59ea02e5":{"description":"The connector profile was updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the connector profile.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"The display name of the connector profile.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"connector_key":{"type":"string","description":"The connector key (e.g. `workday`). Always present; the full connector object requires `?expand=connector`.","isRequired":true,"uniqueKey":"connector_key","typeLabel":"string"},"connector":{"oneOf":[{"type":"object","description":"The connector this profile configures. Always present; `null` unless requested via `?expand=connector`.","required":["key","name","logo_url","categories","release_stage","authentication_config_label"],"properties":{"key":{"type":"string","description":"The connector key (e.g. `workday`).","isRequired":true,"uniqueKey":"connector.oneOf.0.key","typeLabel":"string"},"name":{"type":"string","description":"The human-readable connector name (e.g. `Workday`).","isRequired":true,"uniqueKey":"connector.oneOf.0.name","typeLabel":"string"},"logo_url":{"type":"string","description":"The URL of the connector's logo.","isRequired":true,"uniqueKey":"connector.oneOf.0.logo_url","typeLabel":"string"},"categories":{"description":"The categories the connector belongs to (e.g. `[\"hris\"]`).","type":"array","items":{"type":"string","uniqueKey":"connector.oneOf.0.categories.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"connector.oneOf.0.categories","typeLabel":"string[]"},"release_stage":{"type":"string","description":"The release stage of the connector (e.g. `ga`, `beta`).","isRequired":true,"uniqueKey":"connector.oneOf.0.release_stage","typeLabel":"string"},"authentication_config_label":{"oneOf":[{"type":"string","description":"The human-readable label of the profile's authentication configuration; `null` when the profile has no authentication configuration key.","isRequired":true,"uniqueKey":"connector.oneOf.0.authentication_config_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"The human-readable label of the profile's authentication configuration; `null` when the profile has no authentication configuration key.","isRequired":true,"uniqueKey":"connector.oneOf.0.authentication_config_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector.oneOf.0.authentication_config_label","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"connector.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"connector.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"connector","typeLabel":"object | null"},"version":{"oneOf":[{"type":"object","description":"The connector version this profile resolves to. Always present; `null` unless requested via `?expand=version`.","required":["resolved","pinned","owner"],"properties":{"resolved":{"oneOf":[{"type":"string","description":"The connector version the profile currently resolves to.","isRequired":true,"uniqueKey":"version.oneOf.0.resolved.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector version the profile currently resolves to.","isRequired":true,"uniqueKey":"version.oneOf.0.resolved.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"version.oneOf.0.resolved","typeLabel":"string | null"},"pinned":{"oneOf":[{"type":"string","description":"The explicitly pinned connector version; `null` when no version is pinned.","isRequired":true,"uniqueKey":"version.oneOf.0.pinned.oneOf.0","typeLabel":"string"},{"type":"null","description":"The explicitly pinned connector version; `null` when no version is pinned.","isRequired":true,"uniqueKey":"version.oneOf.0.pinned.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"version.oneOf.0.pinned","typeLabel":"string | null"},"owner":{"oneOf":[{"type":"string","description":"The owner of the resolved connector version.","isRequired":true,"uniqueKey":"version.oneOf.0.owner.oneOf.0","typeLabel":"string"},{"type":"null","description":"The owner of the resolved connector version.","isRequired":true,"uniqueKey":"version.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"version.oneOf.0.owner","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"version.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"version","typeLabel":"object | null"},"accounts_count":{"oneOf":[{"type":"integer","description":"The number of accounts linked to this connector profile that are visible to you. Always present; `null` unless requested via `?expand=accounts_count`.","isRequired":true,"uniqueKey":"accounts_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of accounts linked to this connector profile that are visible to you. Always present; `null` unless requested via `?expand=accounts_count`.","isRequired":true,"uniqueKey":"accounts_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accounts_count","typeLabel":"integer | null"},"enabled_actions_count":{"oneOf":[{"type":"integer","description":"How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. `0` when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; `null` unless requested via `?expand=enabled_actions_count` on a read endpoint, and always `null` on create.","isRequired":true,"uniqueKey":"enabled_actions_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. `0` when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; `null` unless requested via `?expand=enabled_actions_count` on a read endpoint, and always `null` on create.","isRequired":true,"uniqueKey":"enabled_actions_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enabled_actions_count","typeLabel":"integer | null"},"active":{"type":"boolean","description":"Whether the connector profile is active.","isRequired":true,"uniqueKey":"active","typeLabel":"boolean"},"default":{"type":"boolean","description":"Whether this is the default connector profile.","isRequired":true,"uniqueKey":"default","typeLabel":"boolean"},"environment":{"oneOf":[{"type":"string","description":"The environment of the connector profile.","isRequired":true,"uniqueKey":"environment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The environment of the connector profile.","isRequired":true,"uniqueKey":"environment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"environment","typeLabel":"string | null"},"authentication_config_key":{"oneOf":[{"type":"string","description":"The authentication configuration key.","isRequired":true,"uniqueKey":"authentication_config_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The authentication configuration key.","isRequired":true,"uniqueKey":"authentication_config_key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"authentication_config_key","typeLabel":"string | null"},"callback_domain":{"oneOf":[{"type":"string","description":"The hostname of the organization's custom domain the OAuth callback is served on. `null` when the profile uses StackOne's default.","example":"auth.example.com","isRequired":true,"uniqueKey":"callback_domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The hostname of the organization's custom domain the OAuth callback is served on. `null` when the profile uses StackOne's default.","example":"auth.example.com","isRequired":true,"uniqueKey":"callback_domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"callback_domain","typeLabel":"string | null"},"callback_url":{"oneOf":[{"type":"string","description":"The OAuth or OIDC callback URL to allow in the provider app for this profile. With a `callback_domain` it is always `https://\u003ccallback_domain>/connect/oauth2/\u003cconnector_key>/callback`. Without one it is the `redirectUri` set in the setup fields or declared by the connector, otherwise the standard callback path on StackOne's API host. `null` when the authentication configuration is neither OAuth 2.0 nor OIDC. Always present; `null` unless requested via `?expand=callback_url`.","example":"https://auth.example.com/connect/oauth2/hubspot/callback","isRequired":true,"uniqueKey":"callback_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The OAuth or OIDC callback URL to allow in the provider app for this profile. With a `callback_domain` it is always `https://\u003ccallback_domain>/connect/oauth2/\u003cconnector_key>/callback`. Without one it is the `redirectUri` set in the setup fields or declared by the connector, otherwise the standard callback path on StackOne's API host. `null` when the authentication configuration is neither OAuth 2.0 nor OIDC. Always present; `null` unless requested via `?expand=callback_url`.","example":"https://auth.example.com/connect/oauth2/hubspot/callback","isRequired":true,"uniqueKey":"callback_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"callback_url","typeLabel":"string | null"},"created_at":{"type":"string","description":"The timestamp when the connector profile was created.","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","description":"The timestamp when the connector profile was last updated.","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"setup_fields":{"type":"object","additionalProperties":true,"description":"The saved non-secret setup field values, keyed by setup field key.","isRequired":true,"uniqueKey":"setup_fields","typeLabel":"object"},"secrets":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"secrets.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"secrets.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"secrets.additionalProperties","typeLabel":"string | null"},"description":"The saved secret fields, keyed by field key. Values are `__secretvalue:`-prefixed redacted placeholders (never the plaintext); resend a placeholder unchanged to keep the stored secret.","isRequired":true,"uniqueKey":"secrets","typeLabel":"object"},"action_config":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"action_config.additionalProperties.enabled","typeLabel":"boolean"}},"required":["enabled"],"uniqueKey":"action_config.additionalProperties","typeLabel":"object"},"description":"The per-action enablement of the profile, keyed by action id.","isRequired":true,"uniqueKey":"action_config","typeLabel":"object"},"event_config":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the profile processes this event action. Provider events for an event action that is disabled, or missing from `event_config`, are dropped and reach no webhook.","isRequired":true,"uniqueKey":"event_config.additionalProperties.enabled","typeLabel":"boolean"},"webhook_ids":{"type":"array","items":{"type":"string","example":"c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13","uniqueKey":"event_config.additionalProperties.webhook_ids.items.[INDEX]","typeLabel":"string"},"description":"Webhook ids, not URLs: the `id` of each webhook as returned by `GET /v2/webhooks`. These webhooks receive the event action's events for every account linked to the profile. Each must belong to the project; a webhook that is not active receives nothing until it is enabled again. Send an empty list to process the event action without delivering it to a webhook.","isRequired":true,"uniqueKey":"event_config.additionalProperties.webhook_ids","typeLabel":"string[]"}},"required":["enabled","webhook_ids"],"uniqueKey":"event_config.additionalProperties","typeLabel":"object"},"example":{"deel_webhook_employee_created_direct":{"enabled":true,"webhook_ids":["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]},"deel_webhook_employee_updated_direct":{"enabled":false,"webhook_ids":[]}},"description":"The saved event action configuration and the webhooks subscribed to each event action, keyed by event action id. Set it with `event_config` on create or patch.","isRequired":true,"uniqueKey":"event_config","typeLabel":"object"},"sync_config":{"type":"object","additionalProperties":{"type":"object","properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"sync_config.additionalProperties.enabled","typeLabel":"boolean"},"cadence":{"type":"string","isRequired":true,"uniqueKey":"sync_config.additionalProperties.cadence","typeLabel":"string"},"full_sync_after":{"type":"string","isRequired":true,"uniqueKey":"sync_config.additionalProperties.full_sync_after","typeLabel":"string"},"start_at":{"type":"string","uniqueKey":"sync_config.additionalProperties.start_at","typeLabel":"string"},"lookback_start":{"oneOf":[{"type":"string","format":"date","description":"The earliest record date sent to the provider on every run. ISO 8601 date, stored as midnight UTC; `null` turns lookback off. Omit it to keep the stored value, or on a new action to apply the connector default window. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events.","uniqueKey":"sync_config.additionalProperties.lookback_start.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The earliest record date sent to the provider on every run. ISO 8601 date, stored as midnight UTC; `null` turns lookback off. Omit it to keep the stored value, or on a new action to apply the connector default window. Only accepted for an action that supports lookback, and cannot be in the future. Changing it makes the next run a full resync that sends no events.","uniqueKey":"sync_config.additionalProperties.lookback_start.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_config.additionalProperties.lookback_start","typeLabel":"string\u003cdate> | null"},"verify_deletions":{"type":"boolean","description":"Whether a full sync checks each record missing from the listing with the provider before reporting it removed. Omit it to keep the stored value; a new action starts with it off. Only accepted as `true` for an action that supports deletion verification. Each check is one extra action call.","uniqueKey":"sync_config.additionalProperties.verify_deletions","typeLabel":"boolean"},"auto_link":{"type":"boolean","description":"Whether the action syncs automatically on every account linked to this profile. When a save enables an action with no required parameters, omitting it means `true` and `false` is refused; a stored value not saved since may still read `false`. An action with required parameters cannot be newly synced or auto-linked.","uniqueKey":"sync_config.additionalProperties.auto_link","typeLabel":"boolean"}},"required":["enabled","cadence","full_sync_after"],"uniqueKey":"sync_config.additionalProperties","typeLabel":"object"},"description":"The per-action data-sync configuration, keyed by action id.","isRequired":true,"uniqueKey":"sync_config","typeLabel":"object"},"sync_event_subscriptions":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"webhook_id":{"type":"string","description":"The webhook the events are delivered to.","example":"wh_2b8d1f9a","minLength":1,"isRequired":true,"uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX].webhook_id","typeLabel":"string"},"change_types":{"type":"array","minItems":1,"description":"The record changes the subscription is notified about.","example":["added","updated","removed"],"items":{"type":"string","enum":["added","updated","removed"],"description":"The record changes the subscription is notified about.","uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX].change_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX].change_types","typeLabel":"enum\u003cstring>[]"},"enabled":{"oneOf":[{"type":"boolean","description":"Whether the subscription delivers events.","default":true,"uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX].enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the subscription delivers events.","default":true,"uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX].enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX].enabled","typeLabel":"boolean | null"}},"required":["webhook_id","change_types"],"uniqueKey":"sync_event_subscriptions.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sync_event_subscriptions.additionalProperties","typeLabel":"object[]"},"example":{"list_employees":[{"webhook_id":"wh_2b8d1f9a","change_types":["added","updated","removed"]}]},"description":"The webhooks notified of the record changes each sync finds, keyed by action id. Set it with `sync_event_subscriptions` on create or patch.","isRequired":true,"uniqueKey":"sync_event_subscriptions","typeLabel":"object"}},"required":["id","name","connector_key","connector","version","accounts_count","enabled_actions_count","active","default","environment","authentication_config_key","callback_domain","callback_url","created_at","updated_at","setup_fields","secrets","action_config","event_config","sync_config","sync_event_subscriptions"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","connector_key":"\u003cstring>","connector":{"key":"\u003cstring>","name":"\u003cstring>","logo_url":"\u003cstring>","categories":["\u003cstring>"],"release_stage":"\u003cstring>","authentication_config_label":"\u003cstring>"},"version":{"resolved":"\u003cstring>","pinned":"\u003cstring>","owner":"\u003cstring>"},"accounts_count":123,"enabled_actions_count":123,"active":true,"default":true,"environment":"\u003cstring>","authentication_config_key":"\u003cstring>","callback_domain":"auth.example.com","callback_url":"https://auth.example.com/connect/oauth2/hubspot/callback","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","setup_fields":{},"secrets":{},"action_config":{},"event_config":{"deel_webhook_employee_created_direct":{"enabled":true,"webhook_ids":["c4b3f1de-7a2e-4d8b-9f61-5e0a2b7c9d13"]},"deel_webhook_employee_updated_direct":{"enabled":false,"webhook_ids":[]}},"sync_config":{},"sync_event_subscriptions":{"list_employees":[{"webhook_id":"wh_2b8d1f9a","change_types":["added","updated","removed"]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"a9fb83c6-5f42-4024-86a4-2bebc0fd2775":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Bad Request","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"data":{"oneOf":[{"type":"object","description":"Error details","properties":{"statusCode":{"oneOf":[{"type":"number","description":"HTTP status code","example":400,"uniqueKey":"data.oneOf.0.statusCode.oneOf.0","typeLabel":"number"},{"type":"null","description":"HTTP status code","example":400,"uniqueKey":"data.oneOf.0.statusCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.statusCode","typeLabel":"number | null"},"message":{"oneOf":[{"type":"string","description":"Error message","example":"Bad Request","uniqueKey":"data.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error message","example":"Bad Request","uniqueKey":"data.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.message","typeLabel":"string | null"},"headers":{"oneOf":[{"type":"object","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"data.oneOf.0.headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"data.oneOf.0.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.headers","typeLabel":"object | null"}},"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"},"provider_errors":{"oneOf":[{"description":"List of provider-specific errors","type":"array","items":{"type":"object","properties":{"status":{"oneOf":[{"type":"number","description":"HTTP status code of the provider error","example":400,"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].status.oneOf.0","typeLabel":"number"},{"type":"null","description":"HTTP status code of the provider error","example":400,"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].status","typeLabel":"number | null"},"url":{"oneOf":[{"type":"string","description":"URL that caused the error","example":"https://api.provider.com/v1/resource","uniqueKey":"provider_errors.oneOf.0.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL that caused the error","example":"https://api.provider.com/v1/resource","uniqueKey":"provider_errors.oneOf.0.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].url","typeLabel":"string | null"},"raw":{"oneOf":[{"type":"object","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].raw.oneOf.0","typeLabel":"object"},{"type":"null","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].raw.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].raw","typeLabel":"object | null"},"headers":{"oneOf":[{"type":"object","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors.oneOf.0.items.[INDEX].headers","typeLabel":"object | null"}},"uniqueKey":"provider_errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"provider_errors.oneOf.0","typeLabel":"object[]"},{"description":"List of provider-specific errors","type":"null","items":{"type":"object","properties":{"status":{"oneOf":[{"type":"number","description":"HTTP status code of the provider error","example":400},{"type":"null","description":"HTTP status code of the provider error","example":400}]},"url":{"oneOf":[{"type":"string","description":"URL that caused the error","example":"https://api.provider.com/v1/resource"},{"type":"null","description":"URL that caused the error","example":"https://api.provider.com/v1/resource"}]},"raw":{"oneOf":[{"type":"object","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"}},{"type":"null","description":"Raw error response from the provider","example":{"message":"Invalid input parameters"}}]},"headers":{"oneOf":[{"type":"object","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}},{"type":"null","description":"Response headers","example":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}}]}}},"uniqueKey":"provider_errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_errors","typeLabel":"object[] | null"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"Bad Request","timestamp":"2023-05-30T00:00:00.000Z","data":{"statusCode":400,"message":"Bad Request","headers":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}},"provider_errors":[{"status":400,"url":"https://api.provider.com/v1/resource","raw":{"message":"Invalid input parameters"},"headers":{"content-type":"application/json","x-request-id":"5678c28b211dace4e0a0f9171e6b88c5"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"94e7fe46-b03f-4e6e-b588-9070f7f7ef53":{"description":"Unauthorized access.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":401,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"message":"Unauthorized","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"970cf946-93f9-4f02-a5be-adaa26d4b8c5":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":403,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Forbidden resource","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"message":"Forbidden resource","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"0febe48f-f61d-452e-b5cf-4702196c15ac":{"description":"Resource not found.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Not Found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"message":"Not Found","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"68d57a35-ba0f-431d-909c-9c47888db947":{"description":"The request has timed out.","headers":{"Retry-After":{"description":"A time in seconds after which the request can be retried.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":408,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Request timed out","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":408,"message":"Request timed out","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"55eaf46f-6fb8-497b-93d4-76044862b880":{"description":"Conflict with current state.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":409,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Conflict","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":409,"message":"Conflict","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"97a7805b-ce0c-4cc5-add2-f2051b638295":{"description":"Validation error.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":422,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Unprocessable Entity","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":422,"message":"Unprocessable Entity","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"634e8efe-0841-4c14-8454-6662dc2bdb76":{"description":"Too many requests.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":429,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Too many requests","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":429,"message":"Too many requests","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"3b32540b-855f-4d6c-92e5-11dbba81bd8e":{"description":"Server error while executing the request.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":500,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":500,"message":"Internal server error","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"4557d721-b8ab-44e1-90d0-787bcb616403":{"description":"This functionality is not implemented.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":501,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Not Implemented","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":501,"message":"Not Implemented","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"179621cd-f3ea-434b-9b2c-7d468d7b2ee0":{"description":"Bad gateway error.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":502,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"message":{"type":"string","description":"Error message","example":"Bad Gateway","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp when the error occurred","example":"2023-05-30T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"required":["statusCode","message","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":502,"message":"Bad Gateway","timestamp":"2023-05-30T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bec24dc0-b381-415d-9117-6163a7f935a4":{"basic":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basic"}}},"servers":{"bb7cb5c7-4e06-477b-b1ef-1d5d4ba46c54":{"url":"https://api.stackone.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basic"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basic","name":"Authorization"}],"title":"basic"}]},"originalFileLocation":"platform/api-reference/platform-v2.json"},"subdomain":"stackone-60","siteName":"Stackone","title":"Patch a connector profile - Stackone","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T16:53:58.254Z","originalFileLocation":"platform/api-reference/v2/connector-profiles/patch-a-connector-profile.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=\"light\"}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 connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values. action_config, event_config, sync_config and sync_event_subscriptions each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send null, to leave it unchanged.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stackone\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_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/stackone-60/vUkZo0TYnLvO23Z1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Patch a connector profile - Stackone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values. action_config, event_config, sync_config and sync_event_subscriptions each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send null, to leave it unchanged.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stackone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stackone-60.mintlify.site/_mintlify/api/og/v2?division=Connector+Profiles\u0026amp;title=Patch+a+connector+profile\u0026amp;description=Updates+a+connector+profile.+Secrets+resent+as+%60__secretvalue%3A%60-prefixed+placeholders+keep+their+stored+values.+%60action_config%60%2C+%60event_config%60%2C+%60sync_config%60+a\u0026amp;theme=26a0c4b0d3b33d43a09092cd\u0026amp;signature=e5f7ea27730197d5ec72cd4a41aa4309d47dc0787076f15df9fea70e4d685dc2\">\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=\"Patch a connector profile - Stackone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values. action_config, event_config, sync_config and sync_event_subscriptions each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send null, to leave it unchanged.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stackone-60.mintlify.site/_mintlify/api/og/v2?division=Connector+Profiles\u0026amp;title=Patch+a+connector+profile\u0026amp;description=Updates+a+connector+profile.+Secrets+resent+as+%60__secretvalue%3A%60-prefixed+placeholders+keep+their+stored+values.+%60action_config%60%2C+%60event_config%60%2C+%60sync_config%60+a\u0026amp;theme=26a0c4b0d3b33d43a09092cd\u0026amp;signature=e5f7ea27730197d5ec72cd4a41aa4309d47dc0787076f15df9fea70e4d685dc2\">\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/stackone-60/vUkZo0TYnLvO23Z1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stackone\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#068F56\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"gYj1x4gkdSwpCGVLFVXNVOPQ_wVrePW37ZKJt3HEqys\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stackone.com/#organization\",\"name\":\"Stackone\",\"url\":\"https://docs.stackone.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stackone-60/WsmKpuoeBZmio9QO/images/logo/logo-light-mode.svg?fit=max\u0026auto=format\u0026n=WsmKpuoeBZmio9QO\u0026q=85\u0026s=f08be9c0a142cb1e7fcaa23910c4bf7f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stackone.com#website\",\"name\":\"Stackone\",\"url\":\"https://docs.stackone.com\",\"publisher\":{\"@id\":\"https://docs.stackone.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile#webpage\",\"url\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile\",\"name\":\"Patch a connector profile\",\"description\":\"Updates a connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values. action_config, event_config, sync_config and sync_event_subscriptions each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send null, to leave it unchanged.\",\"dateModified\":\"2026-11-10T16:53:58.254Z\",\"isPartOf\":{\"@id\":\"https://docs.stackone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connector Profiles\",\"item\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/list-connector-profiles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Patch a connector profile\",\"item\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile#apireference\",\"headline\":\"Patch a connector profile\",\"name\":\"Patch a connector profile\",\"description\":\"Updates a connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values. action_config, event_config, sync_config and sync_event_subscriptions each replace the stored map when sent as an object: an entry left out is removed, so send every entry that should stay. Omit the field, or send null, to leave it unchanged.\",\"url\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stackone.com/platform/api-reference/v2/connector-profiles/patch-a-connector-profile#webpage\"},\"dateModified\":\"2026-11-10T16:53:58.254Z\",\"publisher\":{\"@id\":\"https://docs.stackone.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stackone.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stackone\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Stackone\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile.md","siteName":"Stackone","nav":{"global":null,"tabs":[{"tab":"Gateway","icon":"rocket","pages":[{"title":"Gateway","href":"/introduction"}]},{"tab":"AI Platforms","icon":"robot","dropdowns":[{"dropdown":"All platforms","icon":"server","description":"Connect any MCP client","groups":[{"group":"Get Started","pages":[{"title":"AI Platforms","sidebarTitle":"Overview","href":"/ai-platforms/overview"},{"title":"StackOne MCP Server","sidebarTitle":"How the MCP Server Works","href":"/ai-platforms/mcp-server"}]}]},{"dropdown":"Anthropic (Claude)","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/mcp/logos/claude.svg","description":"Claude Chat, Cowork and Claude Code","groups":[{"group":"Anthropic (Claude)","pages":[{"title":"Anthropic (Claude)","sidebarTitle":"Overview","href":"/ai-platforms/anthropic/overview"},{"title":"Claude - Make StackOne Available","sidebarTitle":"Organization Admin Setup","href":"/ai-platforms/anthropic/organization-admin-setup"},{"group":"Claude Chat \u0026 Cowork","expanded":true,"pages":[{"title":"Claude Chat \u0026 Cowork - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/anthropic/claude-chat-cowork/organization-user-setup"},{"title":"Claude Chat \u0026 Cowork - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/anthropic/claude-chat-cowork/personal-setup"}]},{"group":"Claude Code","expanded":true,"pages":[{"title":"Claude Code - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/anthropic/claude-code/organization-user-setup"},{"title":"Claude Code - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/anthropic/claude-code/personal-setup"}]}]}]},{"dropdown":"AWS","icon":"aws","description":"Amazon Quick","groups":[{"group":"AWS","pages":[{"title":"AWS","sidebarTitle":"Overview","href":"/ai-platforms/aws/overview"}]},{"group":"Amazon Quick","pages":[{"title":"Amazon Quick - Make StackOne Available","sidebarTitle":"Organization Admin Setup","href":"/ai-platforms/aws/amazon-quick/organization-admin-setup"},{"title":"Amazon Quick - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/aws/amazon-quick/organization-user-setup"},{"title":"Amazon Quick - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/aws/amazon-quick/personal-setup"}]}]},{"dropdown":"Cursor","icon":"arrow-pointer","description":"Cursor editor","groups":[{"group":"Cursor","pages":[{"title":"Cursor","sidebarTitle":"Overview","href":"/ai-platforms/cursor/overview"},{"title":"Cursor - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/cursor/organization-user-setup"},{"title":"Cursor - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/cursor/personal-setup"}]}]},{"dropdown":"Dust","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/mcp/logos/dust.png","description":"Dust assistants and agents","groups":[{"group":"Dust","pages":[{"title":"Dust","sidebarTitle":"Overview","href":"/ai-platforms/dust/overview"},{"title":"Dust - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/dust/connect-stackone"}]}]},{"dropdown":"Glean","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/mcp/logos/glean.png","description":"Glean Agents and Glean Assistant","groups":[{"group":"Glean","pages":[{"title":"Glean","sidebarTitle":"Overview","href":"/ai-platforms/glean/overview"},{"title":"Glean - Make StackOne Available","sidebarTitle":"Organization Admin Setup","href":"/ai-platforms/glean/organization-admin-setup"},{"group":"Glean Agents","expanded":true,"pages":[{"title":"Glean Agents - Connect StackOne","sidebarTitle":"Agent Builder Setup","href":"/ai-platforms/glean/glean-agents/agent-builder-setup"}]},{"group":"Glean Assistant","expanded":true,"pages":[{"title":"Glean Assistant - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/glean/glean-assistant/organization-user-setup"}]}]}]},{"dropdown":"Google","icon":"google","description":"Gemini CLI and Gemini Enterprise","groups":[{"group":"Google","pages":[{"title":"Google","sidebarTitle":"Overview","href":"/ai-platforms/google/overview"}]},{"group":"Gemini CLI","pages":[{"title":"Gemini CLI - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/google/gemini-cli/connect-stackone"}]},{"group":"Gemini Enterprise","pages":[{"title":"Gemini Enterprise - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/google/gemini-enterprise/connect-stackone"}]}]},{"dropdown":"Goose","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/mcp/logos/goose.png","description":"Goose CLI and Desktop","groups":[{"group":"Goose","pages":[{"title":"Goose","sidebarTitle":"Overview","href":"/ai-platforms/goose/overview"},{"title":"Goose - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/goose/connect-stackone"}]}]},{"dropdown":"LangChain","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/mcp/logos/langchain.svg","description":"LangSmith Fleet","groups":[{"group":"LangChain","pages":[{"title":"LangChain","sidebarTitle":"Overview","href":"/ai-platforms/langchain/overview"}]},{"group":"LangSmith Fleet","pages":[{"title":"LangSmith Fleet - Connect StackOne","sidebarTitle":"User Setup","href":"/ai-platforms/langchain/langsmith-fleet/user-setup"}]}]},{"dropdown":"Microsoft","icon":"microsoft","description":"GitHub Copilot and Microsoft 365 Copilot","groups":[{"group":"Microsoft","pages":[{"title":"Microsoft","sidebarTitle":"Overview","href":"/ai-platforms/microsoft/overview"}]},{"group":"GitHub Copilot","pages":[{"title":"GitHub Copilot CLI - Connect StackOne","sidebarTitle":"Copilot CLI User Setup","href":"/ai-platforms/microsoft/github-copilot/copilot-cli"},{"title":"GitHub Copilot in VS Code - Connect StackOne","sidebarTitle":"VS Code User Setup","href":"/ai-platforms/microsoft/github-copilot/vs-code"}]},{"group":"Microsoft 365 Copilot","pages":[{"title":"Microsoft 365 Copilot - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/microsoft/microsoft-365-copilot/connect-stackone"}]}]},{"dropdown":"n8n","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/mcp/logos/n8n.png","description":"n8n workflows","groups":[{"group":"n8n","pages":[{"title":"n8n","sidebarTitle":"Overview","href":"/ai-platforms/n8n/overview"},{"title":"n8n - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/n8n/connect-stackone"}]}]},{"dropdown":"OpenAI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/stackone-60/images/agents/openai-logo.svg","description":"ChatGPT and Codex","groups":[{"group":"OpenAI","pages":[{"title":"OpenAI","sidebarTitle":"Overview","href":"/ai-platforms/openai/overview"}]},{"group":"ChatGPT","pages":[{"title":"ChatGPT - Make StackOne Available","sidebarTitle":"Organization Admin Setup","href":"/ai-platforms/openai/chatgpt/organization-admin-setup"},{"title":"ChatGPT - Connect StackOne","sidebarTitle":"Organization User Setup","href":"/ai-platforms/openai/chatgpt/organization-user-setup"},{"title":"ChatGPT - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/openai/chatgpt/personal-setup"}]},{"group":"Codex","pages":[{"title":"Codex - Connect StackOne","sidebarTitle":"Personal Setup","href":"/ai-platforms/openai/codex/connect-stackone"}]}]}]},{"tab":"Connectors","icon":"plug","pages":[{"title":"Connectors","href":"/connectors/introduction"}]},{"tab":"Embed","icon":"cube","pages":[{"title":"Embed","href":"/embed/overview"}]},{"tab":"Platform API","icon":"code","groups":[{"group":"Overview","root":{"title":"Platform API Reference","href":"/platform-api/overview"},"expanded":true,"pages":[{"title":"Authentication","sidebarTitle":"Authentication","href":"/platform-api/authentication"},{"group":"Request Parameters","pages":[{"title":"Pagination","href":"/platform-api/request-parameters/pagination"},{"title":"Filtering","href":"/platform-api/request-parameters/filtering"},{"title":"Expanding Fields","href":"/platform-api/request-parameters/expanding-fields"}]},{"title":"Rate Limiting","href":"/platform-api/rate-limiting"},{"title":"Platform Events","sidebarTitle":"Platform Events","href":"/platform-api/platform-events"},{"title":"API SDKs","href":"/platform-api/api-sdks"}]},{"group":"Accounts","icon":"users","expanded":true,"pages":[{"openapi":"get /v2/accounts","title":"List accounts","href":"/platform/api-reference/v2/accounts/list-accounts"},{"openapi":"get /v2/accounts/filters","title":"List account filter values","href":"/platform/api-reference/v2/accounts/list-account-filter-values"},{"openapi":"get /v2/accounts/{id}","title":"Get an account","href":"/platform/api-reference/v2/accounts/get-an-account"},{"openapi":"patch /v2/accounts/{id}","title":"Patch an account","href":"/platform/api-reference/v2/accounts/patch-an-account"},{"openapi":"delete /v2/accounts/{id}","title":"Delete an account","href":"/platform/api-reference/v2/accounts/delete-an-account"}]},{"group":"Actions","icon":"bolt","expanded":true,"pages":[{"openapi":"post /actions/search","title":"Search connector actions by semantic similarity","href":"/platform/api-reference/actions/search-connector-actions-by-semantic-similarity"},{"openapi":"post /actions/rpc","title":"Make an RPC call to an action","href":"/platform/api-reference/actions/make-an-rpc-call-to-an-action"},{"openapi":"post /actions/rpc/synced","title":"Read synced action data from the datasync index","href":"/platform/api-reference/actions/read-synced-action-data-from-the-datasync-index"},{"openapi":"post /actions/rpc/synced/queryable_fields","title":"List the fields a synced action's data can be queried by","href":"/platform/api-reference/actions/list-the-fields-a-synced-actions-data-can-be-queried-by"},{"openapi":"post /unified/check_permissions","title":"Check user permissions on a resource","href":"/platform/api-reference/actions/check-user-permissions-on-a-resource"}]},{"group":"Connect Sessions","icon":"link","expanded":true,"pages":[{"openapi":"post /connect_sessions","title":"Create Connect Session","href":"/platform/api-reference/connect-sessions/create-connect-session"},{"openapi":"get /connect_sessions/{id}","title":"Get Connect Session","href":"/platform/api-reference/connect-sessions/get-connect-session"},{"openapi":"post /connect_sessions/authenticate","title":"Authenticate Connect Session","href":"/platform/api-reference/connect-sessions/authenticate-connect-session"}]},{"group":"Connector Profiles","icon":"sliders","expanded":true,"pages":[{"openapi":"get /v2/connector_profiles","title":"List connector profiles","href":"/platform/api-reference/v2/connector-profiles/list-connector-profiles"},{"openapi":"get /v2/connector_profiles/{id}","title":"Get a connector profile","href":"/platform/api-reference/v2/connector-profiles/get-a-connector-profile"},{"openapi":"post /v2/connector_profiles","title":"Create a connector profile","description":"Creates a connector profile and returns its full representation. `enabled_actions_count` cannot be expanded here. Read it back with a `GET`. Besides the authentication, the body can set which actions are enabled (`action_config`), which actions sync data (`sync_config`), which webhooks are notified of the changes those syncs find (`sync_event_subscriptions`) and which provider events are processed and delivered to webhooks (`event_config`).","href":"/platform/api-reference/v2/connector-profiles/create-a-connector-profile"},{"openapi":"patch /v2/connector_profiles/{id}","title":"Patch a connector profile","href":"/platform/api-reference/v2/connector-profiles/patch-a-connector-profile"},{"openapi":"delete /v2/connector_profiles/{id}","title":"Delete a connector profile","description":"Deletes the connector profile and everything configured on it, including its webhook subscriptions and saved secrets. A profile with linked accounts cannot be deleted. The default profile cannot be deleted while two or more alternatives exist for the same connector. With exactly one, that profile becomes the new default if it is enabled; a disabled one leaves the connector without a default until a profile is enabled. Deleting the default needs a project or organization admin, who must also be allowed to update the profile that inherits it.","href":"/platform/api-reference/v2/connector-profiles/delete-a-connector-profile"}]},{"group":"Connectors","icon":"puzzle-piece","expanded":true,"pages":[{"openapi":"get /v2/connectors","title":"List connectors","href":"/platform/api-reference/v2/connectors/list-connectors"},{"openapi":"get /v2/connectors/{id}","title":"Get connector","href":"/platform/api-reference/v2/connectors/get-connector"},{"openapi":"get /v2/connectors/{id}/source","title":"Get connector source","href":"/platform/api-reference/v2/connectors/get-connector-source"},{"openapi":"get /v2/connectors/{id}/actions/{actionId}","title":"Get connector action","href":"/platform/api-reference/v2/connectors/get-connector-action"},{"openapi":"get /v2/connectors/{id}/event_actions/{eventId}","title":"Get connector event action","href":"/platform/api-reference/v2/connectors/get-connector-event-action"},{"openapi":"get /v2/connectors/{id}/versions","title":"List connector versions","href":"/platform/api-reference/v2/connectors/list-connector-versions"},{"openapi":"post /v2/connectors","title":"Create a connector","href":"/platform/api-reference/v2/connectors/create-a-connector"},{"openapi":"post /v2/connectors/{id}/action_refreshes","title":"Create a connector action refresh","href":"/platform/api-reference/v2/connectors/create-a-connector-action-refresh"},{"openapi":"delete /v2/connectors/{id}","title":"Delete a connector","href":"/platform/api-reference/v2/connectors/delete-a-connector"}]},{"group":"Data Sync","icon":"rotate","expanded":true,"pages":[{"group":"Sync Configs","expanded":true,"pages":[{"openapi":"get /v2/data_sync/sync_configs","title":"List sync configs","href":"/platform/api-reference/v2/data-sync/list-sync-configs"},{"openapi":"get /v2/data_sync/sync_configs/{id}","title":"Get a sync config","href":"/platform/api-reference/v2/data-sync/get-a-sync-config"},{"openapi":"get /v2/data_sync/sync_configs/{id}/parameters","title":"Get a sync config action's parameters","href":"/platform/api-reference/v2/data-sync/get-a-sync-config-actions-parameters"},{"openapi":"post /v2/data_sync/sync_configs","title":"Create a sync config","href":"/platform/api-reference/v2/data-sync/create-a-sync-config"},{"openapi":"patch /v2/data_sync/sync_configs/{id}","title":"Patch a sync config","href":"/platform/api-reference/v2/data-sync/patch-a-sync-config"},{"openapi":"delete /v2/data_sync/sync_configs/{id}","title":"Delete a sync config","href":"/platform/api-reference/v2/data-sync/delete-a-sync-config"}]},{"group":"Schedules","expanded":true,"pages":[{"openapi":"get /v2/data_sync/schedules","title":"List schedules","href":"/platform/api-reference/v2/data-sync/list-schedules"},{"openapi":"get /v2/data_sync/schedules/{id}","title":"Get a schedule","href":"/platform/api-reference/v2/data-sync/get-a-schedule"},{"openapi":"patch /v2/data_sync/schedules/{id}","title":"Patch a schedule","href":"/platform/api-reference/v2/data-sync/patch-a-schedule"}]},{"group":"Runs","expanded":true,"pages":[{"openapi":"get /v2/data_sync/runs","title":"List runs","href":"/platform/api-reference/v2/data-sync/list-runs"},{"openapi":"get /v2/data_sync/runs/{id}","title":"Get a run","href":"/platform/api-reference/v2/data-sync/get-a-run"}]}]},{"group":"Logs","icon":"file-lines","expanded":true,"pages":[{"openapi":"post /logs","title":"List Logs","href":"/platform/api-reference/logs/list-logs"},{"openapi":"post /logs/platform","title":"List Platform Logs","href":"/platform/api-reference/logs/list-platform-logs"},{"openapi":"post /logs/provider","title":"List Provider Logs","href":"/platform/api-reference/logs/list-provider-logs"},{"group":"Action Logs","expanded":true,"pages":[{"openapi":"post /logs/actions","title":"List Action Logs","href":"/platform/api-reference/logs/list-action-logs"},{"openapi":"get /logs/actions/{actionRunId}","title":"Get Action Log","href":"/platform/api-reference/logs/get-action-log"},{"openapi":"get /logs/actions/{actionRunId}/advanced","title":"Get Action Advanced Log","href":"/platform/api-reference/logs/get-action-advanced-log"},{"openapi":"get /logs/actions/{actionRunId}/defender","title":"Get Action Defender Log","href":"/platform/api-reference/logs/get-action-defender-log"}]},{"group":"Step Logs","expanded":true,"pages":[{"openapi":"post /logs/steps","title":"List Step Logs","href":"/platform/api-reference/logs/list-step-logs"},{"openapi":"get /logs/actions/{actionRunId}/steps","title":"List Action Step Logs","href":"/platform/api-reference/logs/list-action-step-logs"},{"openapi":"get /logs/actions/{actionRunId}/steps/{stepIndex}","title":"Get Step Log","href":"/platform/api-reference/logs/get-step-log"},{"openapi":"get /logs/actions/{actionRunId}/steps/{stepIndex}/advanced","title":"Get Step Advanced Log","href":"/platform/api-reference/logs/get-step-advanced-log"}]},{"group":"Stats","expanded":true,"pages":[{"openapi":"post /logs/stats/aggregate","title":"Get Logs Stats Aggregate","href":"/platform/api-reference/logs/get-logs-stats-aggregate"},{"openapi":"post /logs/stats/dimensions","title":"Get Logs Stats Dimensions","href":"/platform/api-reference/logs/get-logs-stats-dimensions"}]}]},{"group":"MCP","icon":"plug","expanded":true,"pages":[{"openapi":"post /mcp","title":"Send MCP JSON-RPC message","href":"/platform/api-reference/mcp/send-mcp-json-rpc-message"}]},{"group":"Webhooks","icon":"webhook","expanded":true,"pages":[{"openapi":"get /v2/webhooks","title":"List webhooks","href":"/platform/api-reference/v2/webhooks/list-webhooks"},{"openapi":"get /v2/webhooks/{id}","title":"Get a webhook","href":"/platform/api-reference/v2/webhooks/get-a-webhook"},{"openapi":"post /v2/webhooks","title":"Create a webhook","href":"/platform/api-reference/v2/webhooks/create-a-webhook"},{"openapi":"patch /v2/webhooks/{id}","title":"Update a webhook","href":"/platform/api-reference/v2/webhooks/update-a-webhook"},{"openapi":"delete /v2/webhooks/{id}","title":"Delete a webhook","href":"/platform/api-reference/v2/webhooks/delete-a-webhook"},{"openapi":"post /v2/webhooks/events","title":"Send webhook events","href":"/platform/api-reference/v2/webhooks/send-webhook-events"}]}]}]},"basePath":"","title":"Patch a connector profile - Stackone","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"]}