Optional key that makes the request idempotent. Retrying with the same key returns the original response instead of repeating the operation; keys expire after 24 hours. Any string up to 256 characters. See Idempotency.
Maximum string length: 256
Example:
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
credential_id
string
required
Unique identifier for the credential (prefixed with cred_).
Pattern: ^cred_
Example:
"cred_AbC123xYz456"
Body
application/jsontext/jsonapplication/*+json
Request body for updating a credential. Only include fields you want to change.
auth_credentials
object
Credentials payload. Structure depends on auth_method. For username_password, pass username and password. For username, pass only username, for sources that sign in without a password. For google_sso and apple_sso, pass email and password for the end user's Google or Apple Account. For source_fields, pass at least one entry in source_fields. Any auth_method except none may also include source_fields alongside its credentials (for example, username and password plus source_fields in the same payload), and tokenized to vault selected source-field values.
Show child attributes
external_id
null | string
Updated external identifier. Set to null to remove the mapping.
persistence
object
Updated persistence settings. Setting enabled to false permanently deletes the saved login state.
Show child attributes
geolocation
object | null
Country this credential's task runs come from. An object sets it, null clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.
Show child attributes
Response
OK
id
string
required
Unique identifier for the credential, prefixed with cred_.
Pattern: ^cred_
Example:
"cred_AbC123xYz456"
object
string
required
Always credential.
status
string
required
Credential status: unverified, verified, invalid, or deleted.
source_id
string
required
The source this credential authenticates against. Prefixed with src_.
auth_method
string
required
Authentication method: username_password, username, source_fields, google_sso, apple_sso, or none.
auth_credentials
null | object
required
Summary of stored credentials. Sensitive values are not returned.
Show child attributes
persistence
object
required
Persistence settings for this credential.
Show child attributes
geolocation
object | null
required
Country this credential's task runs come from. null when unset, and Deck picks.
Show child attributes
external_id
null | string
required
External identifier from your system, if set.
created_at
string<date-time>
required
ISO 8601 timestamp of when the resource was created.
Example:
"2026-08-24T12:00:00Z"
updated_at
string<date-time>
required
ISO 8601 timestamp of when the resource was last updated.
Example:
"2026-08-24T12:00:00Z"
request_id
string
required
Unique identifier for the API request. Include this when contacting support.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Deck Docs","description":"Deck is the infrastructure layer for accessing user-permissioned data across industries.","colors":{"primary":"#60917e","light":"#60917e","dark":"#60917e"},"logo":{"light":"https://mintcdn.com/decksoftwareinc/qU-Ph3TxWRaVaZ4z/logo/light.svg?fit=max\u0026auto=format\u0026n=qU-Ph3TxWRaVaZ4z\u0026q=85\u0026s=7219c0996a361a0efa1315710acaece8","dark":"https://mintcdn.com/decksoftwareinc/jwJI_GBuvjfYMken/logo/dark.svg?fit=max\u0026auto=format\u0026n=jwJI_GBuvjfYMken\u0026q=85\u0026s=e9bd389078aeea4f50927a177953c988"},"favicon":"https://mintcdn.com/decksoftwareinc/jwJI_GBuvjfYMken/favicon.png?fit=max\u0026auto=format\u0026n=jwJI_GBuvjfYMken\u0026q=85\u0026s=2346acf6ab834aa5c9464f3061102418","appearance":{"default":"dark","strict":true},"background":{},"navbar":{"primary":{"type":"button","label":"Console","href":"https://console.deck.co"}},"footer":{"socials":{"website":"https://deck.co","github":"https://github.com/buildwithdeck","linkedin":"https://www.linkedin.com/company/deck-platform"}},"fonts":{"heading":{"family":"Plain","weight":500},"body":{"family":"Plain","weight":400}},"integrations":{"ga4":{"measurementId":"G-7797442138"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"decksoftwareinc","hasAudioNarration":false,"actualSubdomain":"decksoftwareinc","customDomains":["docs.deck.co"],"gitSource":{"type":"github","owner":"buildwithdeck","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af340627a7ae7749a635095","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"API Reference","count":65},{"language":"default","tag":"Guides","count":58},{"language":"default","tag":"Development","count":16},{"language":"default","tag":"Get Started","count":16},{"language":"default","tag":"Concepts","count":10},{"language":"default","tag":"Workflows","count":10},{"language":"default","tag":"API","count":9},{"language":"default","tag":"Platform","count":7},{"language":"default","tag":"Event Destinations","count":7},{"language":"default","tag":"Task Runs","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"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","content":"@font-face{font-family:'Plain';src:url('/fonts/PlainRegular.otf') format('opentype');font-weight:400;font-style:normal}@font-face{font-family:'Plain';src:url('/fonts/PlainMedium.otf') format('opentype');font-weight:500;font-style:normal}*{border-radius:0!important}:root{--docs-sidebar-width: 18rem;--docs-toc-width: 16.5rem;--docs-api-code-width: 34rem;--docs-content-max: 48rem;--docs-frame-pad: 1.5rem;--docs-sidebar-pad-x: 1rem;--docs-sidebar-item-pad-x: 0.75rem;--docs-nav-pad-x: calc(var(--docs-sidebar-pad-x) + var(--docs-sidebar-item-pad-x));--docs-border: rgba(246, 246, 246, 0.08);--docs-surface: rgba(246, 246, 246, 0.06);--docs-code-bg: rgba(246, 246, 246, 0.03);--docs-code-radius: 8px;--docs-note-accent: #547DC5;--docs-note-text: #A2B9E2;--docs-warning-accent: #FDFAC3;--docs-tip-accent: #286650;--docs-tip-text: #7AAB98;--docs-check-accent: #60917E;--docs-info-text: #F6F6F6;--docs-page-end-gap: 2.5rem}:root.dark{--tw-text-opacity: 1;--text-primary: #F6F6F6;--text-secondary: #F6F6F6B3}.dark body{color:#F6F6F6}.dark .text-gray-200,.dark .dark\\:text-gray-200{color:#F6F6F6!important}.dark .text-gray-400,.dark .dark\\:text-gray-400,.dark .text-gray-500,.dark .dark\\:text-gray-500{color:rgba(246, 246, 246, 0.7)!important}.dark .text-white,.dark .dark\\:text-white{color:#F6F6F6!important}#navbar .max-w-8xl{max-width:none!important;width:100%;padding-left:var(--docs-nav-pad-x)!important;padding-right:var(--docs-nav-pad-x)!important;box-sizing:border-box}#navbar .h-16,#navbar .h-12{padding-left:0!important;padding-right:0!important;margin-left:0!important;margin-right:0!important}#navbar .ml-auto.justify-end.space-x-4{column-gap:0!important;row-gap:0!important;gap:0!important}#navbar .ml-auto.justify-end.space-x-4>*{margin-left:0!important;margin-right:0!important;margin-inline:0!important}#navbar .ml-auto.justify-end>:not(nav){display:none!important}#navbar{border-bottom:1px solid var(--docs-border)!important}#navbar-transition,#navbar .h-16,#navbar .h-16 *,#navbar .h-12,#navbar .h-12 *{border-bottom:none!important;border-bottom-width:0!important;box-shadow:none!important}.nav-logo{height:18px!important;width:auto!important}[data-component-part=\"version-select-trigger\"],[data-component-part=\"products-selector-trigger\"]{border-radius:6px!important}#search-bar-entry{width:20rem!important;max-width:20rem!important;height:2.25rem!important;padding-right:0.3rem!important;border:none!important;box-shadow:none!important;outline:none!important;--tw-ring-shadow: 0 0 #0000;--tw-ring-offset-shadow: 0 0 #0000;border-radius:6px!important;background:rgba(246, 246, 246, 0.06)!important;filter:none!important}#search-bar-entry:hover{background:rgba(246, 246, 246, 0.09)!important;box-shadow:none!important}#search-bar-entry>span.flex-none{border-radius:4px!important;background:rgba(246, 246, 246, 0.08);padding:0.15rem 0.35rem;font-weight:500;letter-spacing:0.02em;color:rgba(246, 246, 246, 0.55)}#topbar-cta-button a{border-radius:6px!important;padding:0.4rem 0.7rem 0.4rem 0.85rem!important}#topbar-cta-button a>span.absolute{background:#60917E!important;border-radius:6px!important}#topbar-cta-button a:hover>span.absolute{opacity:0.88!important}#topbar-cta-button .text-white{color:#F6F6F6!important}#topbar-cta-button a .z-10{gap:0.35rem!important}#topbar-cta-button svg{display:block!important;width:0.7rem!important;height:0.7rem!important;color:#F6F6F6!important;stroke:currentColor!important}#topbar-cta-button a .z-10::after{display:none!important}div:has(>#sidebar){max-width:none!important;width:100%!important;margin-inline:0!important;padding-inline:0!important}#sidebar{position:sticky!important;left:0;flex-shrink:0!important;width:var(--docs-sidebar-width)!important;margin:0!important;padding:0!important;box-sizing:border-box;border-right:1px solid var(--docs-border)!important;border-right-color:var(--docs-border)!important}#mobile-nav{border-right:1px solid var(--docs-border)!important}#footer,footer#footer{margin-top:var(--docs-page-end-gap)!important;padding-top:var(--docs-page-end-gap)!important;padding-bottom:var(--docs-page-end-gap)!important;border-top:1px solid var(--docs-border)!important;border-top-color:var(--docs-border)!important}#content-area>.invisible.sticky,#content-area>[aria-hidden=\"true\"].sticky{display:none!important;height:0!important;margin:0!important;padding:0!important;overflow:hidden!important}#sidebar-content{padding:0.25rem var(--docs-sidebar-pad-x) 1.5rem;box-sizing:border-box}#sidebar-content .base-ui-disable-scrollbar{padding-right:0.25rem!important}#sidebar a,#sidebar button,#mobile-nav .sidebar-group a,#mobile-nav .sidebar-group button{border-radius:4px!important;padding-right:var(--docs-sidebar-item-pad-x)!important;min-width:0;overflow:visible;white-space:nowrap}#sidebar a span.break-words,#sidebar button span.break-words,#mobile-nav .sidebar-group a span.break-words,#mobile-nav .sidebar-group button span.break-words{min-width:0;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.sidebar-group-header{padding-left:var(--docs-sidebar-item-pad-x)!important}@media (max-width: 1023px){#navbar .max-w-8xl{padding-left:1rem!important;padding-right:1rem!important}#navbar button.h-14.lg\\:hidden{padding-left:0!important;padding-right:0!important}#navbar .ml-auto.justify-end.space-x-4,#topbar-cta-button{display:none!important}#navbar .flex.lg\\:hidden.items-center{display:flex!important}#navbar button[aria-label=\"More actions\"]{display:flex!important}}#search-bar-entry-mobile svg,#navbar button[aria-label=\"More actions\"] svg{background:#F6F6F6!important}#search-bar-entry-mobile:hover svg,#navbar button[aria-label=\"More actions\"]:hover svg{background:rgba(246, 246, 246, 0.7)!important}#mobile-nav [data-component-part=\"version-select-trigger\"],#mobile-nav [data-component-part=\"products-selector-trigger\"],#mobile-nav button.group\\/trigger{border-radius:6px!important;background:var(--docs-surface)!important;border-color:var(--docs-border)!important}#mobile-nav .sidebar-group{padding-left:0.75rem}#mobile-nav [aria-label=\"Close navigation\"]{border-radius:50%!important}html.dark :has(>nav[aria-label=\"Mobile menu\"]){border-radius:8px!important;border:1px solid var(--docs-border)!important;background:#0D100F!important}html.dark nav[aria-label=\"Mobile menu\"] a,html.dark nav[aria-label=\"Mobile menu\"] button{border-radius:6px!important}#content-container,div:has(>#sidebar)>#content-container{flex:1 1 auto!important;min-width:0!important;width:auto!important;max-width:none!important}#content-container>div.flex.flex-row-reverse{display:flex!important;justify-content:flex-start!important;align-items:flex-start!important;width:100%!important;max-width:none!important;gap:0!important;padding-inline:0;box-sizing:border-box}#content-container:has(#table-of-contents) #content-side-layout{position:sticky!important;flex:0 0 var(--docs-toc-width)!important;width:var(--docs-toc-width)!important;max-width:var(--docs-toc-width)!important;margin:0!important;height:calc(100vh - 9.5rem)!important}#table-of-contents-layout{width:var(--docs-toc-width)!important;max-width:var(--docs-toc-width)!important;padding-left:1rem!important;padding-right:var(--docs-nav-pad-x)!important;box-sizing:border-box}#content-area{flex:1 1 auto!important;width:auto!important;min-width:0!important;max-width:none!important;margin:0!important;padding-left:var(--docs-frame-pad)!important;padding-right:var(--docs-frame-pad)!important;display:flex!important;flex-direction:column!important;align-items:center!important;box-sizing:border-box}#content-area>#header,#content-area>#content,#content-area>.mdx-content,#content-area>.feedback-toolbar,#content-area>#pagination,#content-area>footer,#content-area>#footer{width:100%;max-width:var(--docs-content-max)}html[data-page-mode=\"wide\"] #content-area>#header,html[data-page-mode=\"wide\"] #content-area>#content,html[data-page-mode=\"wide\"] #content-area>.mdx-content,html[data-page-mode=\"wide\"] #content-area>.feedback-toolbar,html[data-page-mode=\"wide\"] #content-area>#pagination,html[data-page-mode=\"wide\"] #content-area>footer,html[data-page-mode=\"wide\"] #content-area>#footer{width:100%;max-width:var(--docs-content-max)}#content-container:has(#api-playground-2-operation-page)>div.flex.flex-row-reverse{gap:0!important;padding-right:var(--docs-nav-pad-x);box-sizing:border-box}#content-container:has(#api-playground-2-operation-page) #content-side-layout{flex:0 0 var(--docs-api-code-width)!important;width:var(--docs-api-code-width)!important;max-width:var(--docs-api-code-width)!important;margin:0!important;height:calc(100vh - 9.5rem)!important;padding:0!important}#content-container:has(#api-playground-2-operation-page) #content-side-layout>div{width:100%!important;max-width:none!important}#content-container:has(#api-playground-2-operation-page) #content-area{flex:1 1 auto!important;width:auto!important;max-width:none!important;margin:0!important;padding-left:2.5rem!important;padding-right:2.5rem!important;display:flex!important;flex-direction:column!important;align-items:stretch!important}#content-container:has(#api-playground-2-operation-page) #content-area>#header,#content-container:has(#api-playground-2-operation-page) #content-area>#api-playground-2-operation-page,#content-container:has(#api-playground-2-operation-page) #content-area>#pagination,#content-container:has(#api-playground-2-operation-page) #content-area>footer,#content-container:has(#api-playground-2-operation-page) #content-area>#footer{width:100%;max-width:none!important}#header .eyebrow{color:rgba(246, 246, 246, 0.4)!important;font-weight:400!important;font-size:0.8125rem!important;letter-spacing:0}#page-context-menu{gap:0.35rem}@media (max-width: 1023px){#page-context-menu.ml-auto{display:none!important}#page-context-menu.mt-3{display:flex!important;margin-left:0!important;justify-content:flex-start!important}}#page-context-menu button{border:none!important;box-shadow:none!important;outline:none!important;--tw-ring-shadow: 0 0 #0000;border-radius:6px!important;background:rgba(246, 246, 246, 0.06)!important;color:rgba(246, 246, 246, 0.65)!important}#page-context-menu button:hover{background:rgba(246, 246, 246, 0.1)!important}.feedback-toolbar{margin-top:var(--docs-page-end-gap);padding-top:var(--docs-page-end-gap)!important;padding-bottom:0!important;margin-bottom:0!important;border-top:1px solid var(--docs-border)!important;border-top-color:var(--docs-border)!important;gap:1rem!important}.feedback-toolbar>div{gap:0.75rem!important}#pagination{margin-top:var(--docs-page-end-gap)!important;margin-bottom:0!important;padding-top:0!important;padding-bottom:0!important}.feedback-toolbar p{color:rgba(246, 246, 246, 0.4)!important;font-size:0.8125rem!important;font-weight:400!important;letter-spacing:0}#feedback-thumbs-up,#feedback-thumbs-down{border:none!important;box-shadow:none!important;outline:none!important;--tw-ring-shadow: 0 0 #0000;border-radius:6px!important;background:var(--docs-surface)!important;color:rgba(246, 246, 246, 0.65)!important;padding:0.4rem 0.75rem!important;gap:0.45rem!important}#feedback-thumbs-up:hover,#feedback-thumbs-down:hover{background:rgba(246, 246, 246, 0.1)!important;color:#F6F6F6!important}#feedback-thumbs-up.border,#feedback-thumbs-down.border{background:rgba(96, 145, 126, 0.16)!important;color:#7AAB98!important}#feedback-form,#feedback-form-input,#feedback-form-cancel,#feedback-form-submit{border-radius:6px!important}#feedback-form-input{background:var(--docs-surface)!important;border:1px solid var(--docs-border)!important;color:#F6F6F6!important}#feedback-form-submit{background:#60917E!important;color:#F6F6F6!important;border:none!important}#table-of-contents h2{margin:0 0 0.75rem!important}#table-of-contents h2 button{color:rgba(246, 246, 246, 0.4)!important;font-weight:400!important;font-size:0.8125rem!important;letter-spacing:0;cursor:default}#table-of-contents h2 svg{display:none!important}#table-of-contents-content.toc{position:relative;margin:0!important;padding:0 0 0 0.875rem!important;border-left:1px solid var(--docs-border)!important;list-style:none;min-width:0;overflow:hidden}#table-of-contents-content.toc::before{content:'';position:absolute;top:0;left:-1px;width:2px;height:var(--toc-indicator-h, 0px);background:#F6F6F6;border-radius:1px;pointer-events:none;opacity:var(--toc-indicator-opacity, 0);transform:translateY(var(--toc-indicator-y, 0px));will-change:transform, height}#table-of-contents-content.toc.is-ready::before{transition:transform 220ms cubic-bezier(0.645, 0.045, 0.355, 1),\n height 220ms cubic-bezier(0.645, 0.045, 0.355, 1),\n opacity 150ms ease}#table-of-contents-content.toc>li,#table-of-contents .toc-item{margin-top:0!important;min-width:0}#table-of-contents .toc-item ul{margin:0!important;padding:0!important;list-style:none!important;border:none!important}#table-of-contents .toc-item>a{color:rgba(246, 246, 246, 0.38)!important;text-shadow:none!important;font-weight:400!important;font-size:0.875rem;line-height:1.35;padding-top:0.3rem!important;padding-bottom:0.3rem!important;padding-left:0.2rem!important;display:block;overflow:hidden;text-overflow:ellipsis;white-space:nowrap!important;max-width:100%;word-break:normal!important;overflow-wrap:normal!important;hyphens:none!important;transition:color 150ms ease}#table-of-contents .toc-item[data-depth=\"1\"]>a{padding-left:1.15rem!important}#table-of-contents .toc-item[data-depth=\"2\"]>a{padding-left:2.1rem!important}#table-of-contents .toc-item[data-depth=\"3\"]>a{padding-left:3.05rem!important}#table-of-contents .toc-item[data-depth=\"4\"]>a{padding-left:4rem!important}#table-of-contents .toc-item>a:hover{color:rgba(246, 246, 246, 0.72)!important}#table-of-contents .toc-item.is-current>a{color:#F6F6F6!important}@media (prefers-reduced-motion: reduce){#table-of-contents-content.toc.is-ready::before{transition:none}#table-of-contents .toc-item a{transition:none}}html.dark .code-block.code-block{--shiki-dark-bg: var(--docs-code-bg);border:1px solid var(--docs-border)!important;border-color:var(--docs-border)!important;border-radius:var(--docs-code-radius)!important;background:transparent!important;background-image:none!important;box-shadow:none!important;outline:none!important;overflow:hidden}html.dark .code-block .code-block-background,html.dark .code-block [data-component-part=\"code-block-root\"]{--shiki-dark-bg: var(--docs-code-bg) !important;background:var(--docs-code-bg)!important;background-color:var(--docs-code-bg)!important;background-image:none!important;box-shadow:none!important;border:none!important}html.dark .code-block pre.shiki,html.dark .code-block .shiki{--shiki-dark-bg: transparent !important;background:transparent!important;background-color:transparent!important}.code-block [data-component-part=\"code-block-header\"]{border-radius:0!important;background:transparent!important;border:none!important}html.dark .code-block [data-fade-overlay]{display:none!important;background:none!important;opacity:0!important;width:0!important}html.dark .code-block button,html.dark button[data-testid=\"copy-code-button\"]{border:none!important;box-shadow:none!important;outline:none!important;--tw-ring-shadow: 0 0 #0000 !important;--tw-ring-offset-shadow: 0 0 #0000 !important;--tw-ring-color: transparent !important;border-radius:6px!important;background:rgba(246, 246, 246, 0.08)!important;background-color:rgba(246, 246, 246, 0.08)!important}html.dark .code-block button:hover,html.dark button[data-testid=\"copy-code-button\"]:hover{background:rgba(246, 246, 246, 0.14)!important;background-color:rgba(246, 246, 246, 0.14)!important}html.dark .code-group{--rounded-xl: 4px;--radius-xl: 4px;border-radius:var(--docs-code-radius)!important;border-color:var(--docs-border)!important;overflow:hidden}html.dark .code-group [data-component-part=\"code-block-root\"],html.dark .code-group .code-block-background,html.dark .code-group .rounded-xt,html.dark .code-group [class*=\"rounded-xt\"]{--rounded-xl: 4px !important;--radius-xl: 4px !important;border-radius:4px!important}html.dark .code-group [data-component-part=\"code-block-root\"]::before,html.dark .code-group [class*=\"rounded-xt\"]::before,html.dark .code-group [class*=\"before:rounded\"]::before{border-radius:4px!important}html.dark .code-group [data-component-part=\"scroll-area-viewport\"]{border-radius:inherit!important}html.dark .callout{border-radius:8px!important}html.dark .callout[data-callout-type=\"note\"]{border:1px solid rgba(84, 125, 197, 0.4)!important;border-color:rgba(84, 125, 197, 0.4)!important;background:rgba(84, 125, 197, 0.14)!important;background-color:rgba(84, 125, 197, 0.14)!important;border-radius:8px!important}html.dark .callout[data-callout-type=\"note\"] [data-component-part=\"callout-icon\"],html.dark .callout[data-callout-type=\"note\"] [data-component-part=\"callout-icon\"] svg,html.dark .callout[data-callout-type=\"note\"] [data-component-part=\"callout-content\"],html.dark .callout[data-callout-type=\"note\"] [data-component-part=\"callout-content\"] *{color:#A2B9E2!important}html.dark .callout[data-callout-type=\"warning\"]{border:1px solid rgba(253, 250, 195, 0.4)!important;border-color:rgba(253, 250, 195, 0.4)!important;background:rgba(253, 250, 195, 0.14)!important;background-color:rgba(253, 250, 195, 0.14)!important;border-radius:8px!important}html.dark .callout[data-callout-type=\"warning\"] [data-component-part=\"callout-icon\"],html.dark .callout[data-callout-type=\"warning\"] [data-component-part=\"callout-icon\"] svg,html.dark .callout[data-callout-type=\"warning\"] [data-component-part=\"callout-content\"],html.dark .callout[data-callout-type=\"warning\"] [data-component-part=\"callout-content\"] *{color:#FDFAC3!important}html.dark .callout[data-callout-type=\"tip\"]{border:1px solid rgba(96, 145, 126, 0.45)!important;border-color:rgba(96, 145, 126, 0.45)!important;background:rgba(40, 102, 80, 0.18)!important;background-color:rgba(40, 102, 80, 0.18)!important;border-radius:8px!important}html.dark .callout[data-callout-type=\"tip\"] [data-component-part=\"callout-icon\"],html.dark .callout[data-callout-type=\"tip\"] [data-component-part=\"callout-icon\"] svg,html.dark .callout[data-callout-type=\"tip\"] [data-component-part=\"callout-content\"],html.dark .callout[data-callout-type=\"tip\"] [data-component-part=\"callout-content\"] *{color:#7AAB98!important}html.dark .callout[data-callout-type=\"check\"]{border:1px solid rgba(96, 145, 126, 0.45)!important;border-color:rgba(96, 145, 126, 0.45)!important;background:rgba(96, 145, 126, 0.16)!important;background-color:rgba(96, 145, 126, 0.16)!important}html.dark .callout[data-callout-type=\"check\"] [data-component-part=\"callout-icon\"],html.dark .callout[data-callout-type=\"check\"] [data-component-part=\"callout-icon\"] svg,html.dark .callout[data-callout-type=\"check\"] [data-component-part=\"callout-content\"],html.dark .callout[data-callout-type=\"check\"] [data-component-part=\"callout-content\"] *{color:#7AAB98!important}html.dark .callout[data-callout-type=\"info\"]{border:1px solid rgba(246, 246, 246, 0.16)!important;border-color:rgba(246, 246, 246, 0.16)!important;background:rgba(246, 246, 246, 0.06)!important;background-color:rgba(246, 246, 246, 0.06)!important}html.dark .callout[data-callout-type=\"info\"] [data-component-part=\"callout-icon\"],html.dark .callout[data-callout-type=\"info\"] [data-component-part=\"callout-icon\"] svg,html.dark .callout[data-callout-type=\"info\"] [data-component-part=\"callout-content\"],html.dark .callout[data-callout-type=\"info\"] [data-component-part=\"callout-content\"] *{color:#F6F6F6!important}html.dark [data-component-part=\"tabs-list\"] [data-component-part=\"tab-button\"]{color:rgba(246, 246, 246, 0.6)!important;border-bottom-color:transparent!important}html.dark [data-component-part=\"tabs-list\"] [data-component-part=\"tab-button\"][data-active=\"true\"]{color:#F6F6F6!important;border-bottom-color:#60917E!important}html.dark [data-component-part=\"code-group-tab-bar\"] [role=\"tab\"]{color:rgba(246, 246, 246, 0.6)!important}html.dark [data-component-part=\"code-group-tab-bar\"] [role=\"tab\"][aria-selected=\"true\"],html.dark [data-component-part=\"code-group-tab-bar\"] [role=\"tab\"][data-active]{color:#F6F6F6!important}html.dark [data-component-part=\"code-group-tab-bar\"] [role=\"tab\"]>div:first-child{border-radius:6px!important;color:inherit!important}html.dark [data-component-part=\"code-group-tab-bar\"] [role=\"tab\"][aria-selected=\"true\"]>div:last-child{background:#60917E!important;background-color:#60917E!important;border-radius:999px!important}.accordion-group,details.accordion{border-radius:8px!important;overflow:hidden!important}.accordion-group details.accordion{border-radius:0!important}.accordion [data-component-part=\"accordion-button\"]{gap:0.5rem}.accordion [data-component-part=\"accordion-button\"]>div{margin-left:0!important;margin-right:0!important}.accordion [data-component-part=\"accordion-title-container\"]{order:1;flex:1 1 auto;width:auto!important}.accordion [data-component-part=\"accordion-caret-right\"]{order:2;flex:0 0 auto;margin-left:auto!important}.accordion [data-component-part=\"accordion-caret-right\"] svg{width:0.75rem!important;height:0.75rem!important;background-color:rgba(246, 246, 246, 0.7)!important;-webkit-mask-image:url(\"https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/chevron-down.svg\")!important;mask-image:url(\"https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/chevron-down.svg\")!important;-webkit-mask-repeat:no-repeat!important;mask-repeat:no-repeat!important;-webkit-mask-position:center!important;mask-position:center!important;-webkit-mask-size:contain!important;mask-size:contain!important;transition:rotate 75ms ease-out!important;rotate:0deg;transform:none!important}.accordion[open] [data-component-part=\"accordion-caret-right\"] svg,.accordion [data-component-part=\"accordion-button\"][aria-expanded=\"true\"] [data-component-part=\"accordion-caret-right\"] svg{rotate:180deg!important}html.dark tooltip,html.dark [role=\"tooltip\"],html.dark #text-selection-tooltip{background:#0D100F!important;background-color:#0D100F!important;border:1px solid rgba(246, 246, 246, 0.12)!important;border-color:rgba(246, 246, 246, 0.12)!important;border-radius:4px!important;color:#F6F6F6!important}html.dark [role=\"menu\"],html.dark [role=\"listbox\"],html.dark nav-dropdown-content,html.dark option-dropdown,html.dark multi-view-dropdown-content,html.dark #localization-select-content,html.dark [data-component-part=\"theme-preference-menu-content\"],html.dark [data-component-part=\"version-select-content\"],html.dark [data-component-part=\"products-selector-content\"],html.dark nav-dropdown-products-selector-content,html.dark [data-component-part=\"search-filter-content\"]{border-radius:8px!important}html.dark [data-component-part=\"search-modal\"]{border-radius:8px!important;border:1px solid var(--docs-border)!important;background:#0D100F!important;box-shadow:none!important}html.dark [data-component-part=\"search-input-container\"],html.dark [data-component-part=\"search-cli-state\"]{border-radius:6px!important;background:rgba(246, 246, 246, 0.06)!important;border-color:var(--docs-border)!important}html.dark [data-component-part=\"search-item\"],html.dark [data-component-part=\"search-ask-ai-item\"]{border-radius:6px!important}html.dark [role=\"menuitem\"],html.dark [role=\"option\"]{border-radius:6px!important}html.dark [role=\"menuitem\"]>div:first-child{border-radius:6px!important}.mdx-content video,.mdx-content img,.mdx-content .frame,.mdx-content [data-name=\"frame\"]{display:block;width:100%;max-width:100%;height:auto}.prose :where(img):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){margin-top:0!important}.mdx-content video,.mdx-content iframe,.mdx-content img,.mdx-content .frame,.mdx-content [data-name=\"frame\"]{border-radius:8px!important}.mdx-content video,.mdx-content img,.mdx-content .frame,.mdx-content [data-name=\"frame\"]{overflow:hidden!important}.mdx-content .frame img,.mdx-content [data-name=\"frame\"] img{border-radius:0!important}html.dark .card,html.dark card,html.dark tile{border-radius:8px!important;background:rgba(246, 246, 246, 0.04)!important;background-color:rgba(246, 246, 246, 0.04)!important;border-color:var(--docs-border)!important;overflow:hidden!important}html.dark .card [data-component-part=\"card-content\"],html.dark card [data-component-part=\"card-content\"],html.dark tile [data-component-part=\"card-content\"]{font-size:0.875rem!important;line-height:1.5!important;text-wrap:balance;text-wrap:pretty}html.dark mermaid,html.dark [data-component-name=\"mermaid-container\"]{display:block;border:1px solid var(--docs-border)!important;border-radius:8px!important;background:rgba(246, 246, 246, 0.04)!important;background-color:rgba(246, 246, 246, 0.04)!important;padding:1.5rem 1.25rem!important;overflow:hidden!important}html.dark [data-component-name=\"mermaid-container\"] mermaid{border:none!important;background:transparent!important;padding:0!important;border-radius:0!important;overflow:visible!important}html.dark mermaid svg,html.dark [data-component-name=\"mermaid-container\"] svg{background:transparent!important}html.dark mermaid rect.actor,html.dark [data-component-name=\"mermaid-container\"] rect.actor{rx:8px!important;ry:8px!important}html.dark mermaid .messageLine0,html.dark [data-component-name=\"mermaid-container\"] .messageLine0{stroke:#60917E!important}html.dark mermaid .messageLine1,html.dark [data-component-name=\"mermaid-container\"] .messageLine1{stroke:rgba(205, 205, 205, 0.55)!important}html.dark mermaid .messageText,html.dark mermaid text.actor,html.dark mermaid text.actor tspan,html.dark mermaid .messageText tspan,html.dark [data-component-name=\"mermaid-container\"] .messageText,html.dark [data-component-name=\"mermaid-container\"] text.actor,html.dark [data-component-name=\"mermaid-container\"] text.actor tspan,html.dark [data-component-name=\"mermaid-container\"] .messageText tspan{fill:#F6F6F6!important;font-family:Plain, sans-serif!important}html.dark mermaid marker path,html.dark [data-component-name=\"mermaid-container\"] marker path{fill:#60917E!important;stroke:#60917E!important}#content table th,#content table td{padding-top:0.875rem!important;padding-bottom:0.875rem!important}[data-component-part=\"step-number\"]>div{border-radius:50%!important}#content a.link,#content a.link:hover{color:#F6F6F6!important;border-bottom-color:#60917E!important;text-decoration-color:#60917E!important}#content .callout a.link,#content .callout a.link:hover{color:inherit!important;border-bottom-color:currentColor!important;text-decoration-color:currentColor!important}html.dark .code-block,html.dark .code-block pre,html.dark .code-block code,html.dark .code-group .code-block-background,html.dark .code-group [data-component-part=\"code-block-root\"],html.dark .code-group [data-component-part=\"code-group-tab-content\"],html.dark .code-group pre,html.dark .code-group code{font-size:13px!important}html.dark code:not(pre *){border-radius:4px!important;border:1px solid var(--docs-border)!important;font-size:13px!important}#content-container:has(#api-playground-2-operation-page) [data-component-part=\"field-name\"]{color:#F6F6F6!important;font-size:15px!important;font-weight:500!important}#sidebar .method-pill,#sidebar .method-nav-pill>span,#mobile-nav .method-pill,#mobile-nav .method-nav-pill>span,#content-container:has(#api-playground-2-operation-page) .method-pill,#content-container:has(#api-playground-2-operation-page) [data-component-part=\"field-info-pill\"],#content-container:has(#api-playground-2-operation-page) [data-component-part=\"field-required-pill\"]{border-radius:4px!important}#content-container:has(#api-playground-2-operation-page) [data-component-part=\"field-info-pill\"],#content-container:has(#api-playground-2-operation-page) [data-component-part=\"field-info-pill\"] *,#content-container:has(#api-playground-2-operation-page) [data-component-part=\"field-meta\"] .option-dropdown{color:rgba(246, 246, 246, 0.55)!important}#sidebar .method-nav-pill,#mobile-nav .method-nav-pill{overflow:visible!important;flex-shrink:0!important}#sidebar .method-nav-pill>span,#mobile-nav .method-nav-pill>span{width:max-content!important;max-width:none!important;overflow:visible!important;text-overflow:clip!important;white-space:nowrap!important}#content-container:has(#api-playground-2-operation-page) .tryit-button,#content-container:has(#api-playground-2-operation-page) button[aria-label=\"Copy\"],#content-container:has(#api-playground-2-operation-page) button[aria-label=\"Select language\"],#content-container:has(#api-playground-2-operation-page) [data-component-part=\"version-select-trigger\"],#content-container:has(#api-playground-2-operation-page) .code-group button{border-radius:6px!important}#content-container:has(#api-playground-2-operation-page) .border-standard,#content-container:has(#api-playground-2-operation-page) [data-component-part=\"expandable\"],#content-container:has(#api-playground-2-operation-page) [data-component-part=\"expandable-button\"]{border-radius:8px!important}#content-container:has(#api-playground-2-operation-page) .border-standard.rounded-xl{border-radius:6px!important}"}],"page":{"pagePath":"api-reference/credentials/update-a-credential","slug":"/api-reference/credentials/update-a-credential","pageMetadata":{"title":"Update a credential","description":"Updates a credential's authentication details or external ID. Only the fields you include in the request body are updated.","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /credentials/{credential_id}","href":"/api-reference/credentials/update-a-credential","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a credential’s authentication details or external ID. Only the fields you include in the request body are updated.\"\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":{"title":"Update a credential","description":"Updates a credential's authentication details or external ID. Only the fields you include in the request body are updated.","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /credentials/{credential_id}","href":"/api-reference/credentials/update-a-credential","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/decksoftwareinc/60feb3fe1b2400a1/mermaid.js","/_mintlify/custom/decksoftwareinc/53c63d97f88b046e/toc.js"],"openApiReferenceData":{"operation":{"tags":["Credentials"],"summary":"Update a credential","parameters":["4a0e695b-c0f2-46d7-9269-ced3e967ea48","b449d27c-32e6-49eb-bade-e01678e87ab7"],"requestBody":"d221806b-844b-4389-9111-a1a228784a23","responses":{"200":"f0545a23-5f6d-4b4b-a49c-1add6b248cc6","400":"74165566-0a24-4aaf-9ab5-46e3f593f377","401":"8432be81-e3f6-408c-b665-f3a40e32816c","403":"de33ddae-d06b-471e-8aa2-b8321afc00fd","404":"8981b626-d179-47dd-ab47-a0d2e3893646","409":"1ef19a83-b7c6-41f3-b1b1-f47494729a57","422":"e7064fce-eaf2-49ad-8ae9-1ac7d002164c","429":"d9c28127-eccb-41ab-91a3-34f1ac771db6","500":"d7bdeaa5-3aa2-423a-a3ce-f8df092e5754"},"operationId":"updateCredential","description":"Updates a credential's authentication details or external ID. Only the fields you include in the request body are updated.","method":"patch","type":"path","servers":["11088669-f0e3-446e-9f56-9d49b375b996"],"security":["70a6cd60-7554-4caa-8414-b07034a86562"],"path":"/credentials/{credential_id}","baseUrlOptions":["https://api.deck.co/v2"],"title":"Update a credential","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4a0e695b-c0f2-46d7-9269-ced3e967ea48":{"name":"credential_id","in":"path","required":true,"schema":{"type":"string","pattern":"^cred_","example":"cred_AbC123xYz456","isRequired":true,"description":"Unique identifier for the credential (prefixed with `cred_`).","uniqueKey":"","typeLabel":"string"},"description":"Unique identifier for the credential (prefixed with `cred_`)."},"b449d27c-32e6-49eb-bade-e01678e87ab7":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional key that makes the request idempotent. Retrying with the same key returns the original response instead of repeating the operation; keys expire after 24 hours. Any string up to 256 characters. See [Idempotency](/api/idempotency).","schema":{"type":"string","maxLength":256,"example":"550e8400-e29b-41d4-a716-446655440000","isRequired":false,"description":"Optional key that makes the request idempotent. Retrying with the same key returns the original response instead of repeating the operation; keys expire after 24 hours. Any string up to 256 characters. See [Idempotency](/api/idempotency).","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"auth_credentials":{"type":"object","properties":{"username":{"type":"string","description":"Username for `username_password` and `username`.","uniqueKey":"auth_credentials.username","typeLabel":"string"},"email":{"type":"string","description":"The end user's Google or Apple Account email, for `google_sso` and `apple_sso`. Must be a valid email address.","uniqueKey":"auth_credentials.email","typeLabel":"string"},"password":{"type":"string","description":"Password for `username_password`, or the Google or Apple Account password for `google_sso` and `apple_sso`. Encrypted at rest and never returned.","uniqueKey":"auth_credentials.password","typeLabel":"string"},"source_fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"auth_credentials.source_fields.additionalProperties","typeLabel":"string"},"description":"Additional values the source requires at login, beyond what the `auth_method` covers (for example, `{ \"company_id\": \"ACME-4412\" }`). For the `source_fields` auth method, at least one entry is required. Values must be strings. Keys must match `^[a-z][a-z0-9_]{0,63}$`, must not collide with reserved keys on the `auth_method` (such as `username`, `email` or `password`), and are capped at 10 entries per credential. Values are returned in the clear on read unless named in `tokenized`.","uniqueKey":"auth_credentials.source_fields","typeLabel":"object"},"tokenized":{"type":"array","items":{"type":"string","uniqueKey":"auth_credentials.tokenized.items.[INDEX]","typeLabel":"string"},"description":"Names of `source_fields` keys to vault. Each entry must name a key present in `source_fields`. Tokenized values are stored in a secure vault, removed from API responses, and listed by name in the response `tokenized` array; they cannot be read back. On update, may only name keys supplied in the same request. Auth secrets such as `password` are always vaulted regardless of this array.","uniqueKey":"auth_credentials.tokenized","typeLabel":"string[]"}},"description":"Credentials payload. Structure depends on `auth_method`. For `username_password`, pass `username` and `password`. For `username`, pass only `username`, for sources that sign in without a password. For `google_sso` and `apple_sso`, pass `email` and `password` for the end user's Google or Apple Account. For `source_fields`, pass at least one entry in `source_fields`. Any `auth_method` except `none` may also include `source_fields` alongside its credentials (for example, `username` and `password` plus `source_fields` in the same payload), and `tokenized` to vault selected source-field values.","uniqueKey":"auth_credentials","typeLabel":"object"},"external_id":{"oneOf":[{"type":"null","description":"Updated external identifier. Set to `null` to remove the mapping.","uniqueKey":"external_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"Updated external identifier. Set to `null` to remove the mapping.","uniqueKey":"external_id.oneOf.1","typeLabel":"string"}],"uniqueKey":"external_id","typeLabel":"null | string"},"persistence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to save this credential's login state between runs. Defaults to `false`.","uniqueKey":"persistence.enabled","typeLabel":"boolean"}},"description":"Updated persistence settings. Setting `enabled` to `false` permanently deletes the saved login state.","uniqueKey":"persistence","typeLabel":"object"},"geolocation":{"oneOf":[{"type":"object","description":"Country this credential's task runs come from. An object sets it, `null` clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.","required":["country"],"properties":{"country":{"type":"string","enum":["AU","BR","CA","CO","CZ","DE","EC","ES","FR","GB","IE","IT","JP","MY","PL","PT","US"],"description":"ISO 3166-1 alpha-2 country code, case-insensitive. Every task run on the credential gets a Deck IP address in this country, and never falls back to another country.","example":"US","isRequired":true,"uniqueKey":"geolocation.oneOf.0.country","typeLabel":"enum\u003cstring>"}},"uniqueKey":"geolocation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Country this credential's task runs come from. An object sets it, `null` clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.","uniqueKey":"geolocation.oneOf.1","typeLabel":"null"}],"uniqueKey":"geolocation","typeLabel":"object | null"}},"description":"Request body for updating a credential. Only include fields you want to change.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"auth_credentials":{"username":"\u003cstring>","email":"\u003cstring>","password":"\u003cstring>","source_fields":{},"tokenized":["\u003cstring>"]},"external_id":"\u003cstring>","persistence":{"enabled":true},"geolocation":{"country":"US"}}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"auth_credentials":{"type":"object","properties":{"username":{"type":"string","description":"Username for `username_password` and `username`.","uniqueKey":"auth_credentials.username","typeLabel":"string"},"email":{"type":"string","description":"The end user's Google or Apple Account email, for `google_sso` and `apple_sso`. Must be a valid email address.","uniqueKey":"auth_credentials.email","typeLabel":"string"},"password":{"type":"string","description":"Password for `username_password`, or the Google or Apple Account password for `google_sso` and `apple_sso`. Encrypted at rest and never returned.","uniqueKey":"auth_credentials.password","typeLabel":"string"},"source_fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"auth_credentials.source_fields.additionalProperties","typeLabel":"string"},"description":"Additional values the source requires at login, beyond what the `auth_method` covers (for example, `{ \"company_id\": \"ACME-4412\" }`). For the `source_fields` auth method, at least one entry is required. Values must be strings. Keys must match `^[a-z][a-z0-9_]{0,63}$`, must not collide with reserved keys on the `auth_method` (such as `username`, `email` or `password`), and are capped at 10 entries per credential. Values are returned in the clear on read unless named in `tokenized`.","uniqueKey":"auth_credentials.source_fields","typeLabel":"object"},"tokenized":{"type":"array","items":{"type":"string","uniqueKey":"auth_credentials.tokenized.items.[INDEX]","typeLabel":"string"},"description":"Names of `source_fields` keys to vault. Each entry must name a key present in `source_fields`. Tokenized values are stored in a secure vault, removed from API responses, and listed by name in the response `tokenized` array; they cannot be read back. On update, may only name keys supplied in the same request. Auth secrets such as `password` are always vaulted regardless of this array.","uniqueKey":"auth_credentials.tokenized","typeLabel":"string[]"}},"description":"Credentials payload. Structure depends on `auth_method`. For `username_password`, pass `username` and `password`. For `username`, pass only `username`, for sources that sign in without a password. For `google_sso` and `apple_sso`, pass `email` and `password` for the end user's Google or Apple Account. For `source_fields`, pass at least one entry in `source_fields`. Any `auth_method` except `none` may also include `source_fields` alongside its credentials (for example, `username` and `password` plus `source_fields` in the same payload), and `tokenized` to vault selected source-field values.","uniqueKey":"auth_credentials","typeLabel":"object"},"external_id":{"oneOf":[{"type":"null","description":"Updated external identifier. Set to `null` to remove the mapping.","uniqueKey":"external_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"Updated external identifier. Set to `null` to remove the mapping.","uniqueKey":"external_id.oneOf.1","typeLabel":"string"}],"uniqueKey":"external_id","typeLabel":"null | string"},"persistence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to save this credential's login state between runs. Defaults to `false`.","uniqueKey":"persistence.enabled","typeLabel":"boolean"}},"description":"Updated persistence settings. Setting `enabled` to `false` permanently deletes the saved login state.","uniqueKey":"persistence","typeLabel":"object"},"geolocation":{"oneOf":[{"type":"object","description":"Country this credential's task runs come from. An object sets it, `null` clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.","required":["country"],"properties":{"country":{"type":"string","enum":["AU","BR","CA","CO","CZ","DE","EC","ES","FR","GB","IE","IT","JP","MY","PL","PT","US"],"description":"ISO 3166-1 alpha-2 country code, case-insensitive. Every task run on the credential gets a Deck IP address in this country, and never falls back to another country.","example":"US","isRequired":true,"uniqueKey":"geolocation.oneOf.0.country","typeLabel":"enum\u003cstring>"}},"uniqueKey":"geolocation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Country this credential's task runs come from. An object sets it, `null` clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.","uniqueKey":"geolocation.oneOf.1","typeLabel":"null"}],"uniqueKey":"geolocation","typeLabel":"object | null"}},"description":"Request body for updating a credential. Only include fields you want to change.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"auth_credentials":{"username":"\u003cstring>","email":"\u003cstring>","password":"\u003cstring>","source_fields":{},"tokenized":["\u003cstring>"]},"external_id":"\u003cstring>","persistence":{"enabled":true},"geolocation":{"country":"US"}}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"auth_credentials":{"type":"object","properties":{"username":{"type":"string","description":"Username for `username_password` and `username`.","uniqueKey":"auth_credentials.username","typeLabel":"string"},"email":{"type":"string","description":"The end user's Google or Apple Account email, for `google_sso` and `apple_sso`. Must be a valid email address.","uniqueKey":"auth_credentials.email","typeLabel":"string"},"password":{"type":"string","description":"Password for `username_password`, or the Google or Apple Account password for `google_sso` and `apple_sso`. Encrypted at rest and never returned.","uniqueKey":"auth_credentials.password","typeLabel":"string"},"source_fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"auth_credentials.source_fields.additionalProperties","typeLabel":"string"},"description":"Additional values the source requires at login, beyond what the `auth_method` covers (for example, `{ \"company_id\": \"ACME-4412\" }`). For the `source_fields` auth method, at least one entry is required. Values must be strings. Keys must match `^[a-z][a-z0-9_]{0,63}$`, must not collide with reserved keys on the `auth_method` (such as `username`, `email` or `password`), and are capped at 10 entries per credential. Values are returned in the clear on read unless named in `tokenized`.","uniqueKey":"auth_credentials.source_fields","typeLabel":"object"},"tokenized":{"type":"array","items":{"type":"string","uniqueKey":"auth_credentials.tokenized.items.[INDEX]","typeLabel":"string"},"description":"Names of `source_fields` keys to vault. Each entry must name a key present in `source_fields`. Tokenized values are stored in a secure vault, removed from API responses, and listed by name in the response `tokenized` array; they cannot be read back. On update, may only name keys supplied in the same request. Auth secrets such as `password` are always vaulted regardless of this array.","uniqueKey":"auth_credentials.tokenized","typeLabel":"string[]"}},"description":"Credentials payload. Structure depends on `auth_method`. For `username_password`, pass `username` and `password`. For `username`, pass only `username`, for sources that sign in without a password. For `google_sso` and `apple_sso`, pass `email` and `password` for the end user's Google or Apple Account. For `source_fields`, pass at least one entry in `source_fields`. Any `auth_method` except `none` may also include `source_fields` alongside its credentials (for example, `username` and `password` plus `source_fields` in the same payload), and `tokenized` to vault selected source-field values.","uniqueKey":"auth_credentials","typeLabel":"object"},"external_id":{"oneOf":[{"type":"null","description":"Updated external identifier. Set to `null` to remove the mapping.","uniqueKey":"external_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"Updated external identifier. Set to `null` to remove the mapping.","uniqueKey":"external_id.oneOf.1","typeLabel":"string"}],"uniqueKey":"external_id","typeLabel":"null | string"},"persistence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to save this credential's login state between runs. Defaults to `false`.","uniqueKey":"persistence.enabled","typeLabel":"boolean"}},"description":"Updated persistence settings. Setting `enabled` to `false` permanently deletes the saved login state.","uniqueKey":"persistence","typeLabel":"object"},"geolocation":{"oneOf":[{"type":"object","description":"Country this credential's task runs come from. An object sets it, `null` clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.","required":["country"],"properties":{"country":{"type":"string","enum":["AU","BR","CA","CO","CZ","DE","EC","ES","FR","GB","IE","IT","JP","MY","PL","PT","US"],"description":"ISO 3166-1 alpha-2 country code, case-insensitive. Every task run on the credential gets a Deck IP address in this country, and never falls back to another country.","example":"US","isRequired":true,"uniqueKey":"geolocation.oneOf.0.country","typeLabel":"enum\u003cstring>"}},"uniqueKey":"geolocation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Country this credential's task runs come from. An object sets it, `null` clears it so Deck picks, and omitting it leaves it unchanged. Setting a country is Enterprise only.","uniqueKey":"geolocation.oneOf.1","typeLabel":"null"}],"uniqueKey":"geolocation","typeLabel":"object | null"}},"description":"Request body for updating a credential. Only include fields you want to change.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"auth_credentials":{"username":"\u003cstring>","email":"\u003cstring>","password":"\u003cstring>","source_fields":{},"tokenized":["\u003cstring>"]},"external_id":"\u003cstring>","persistence":{"enabled":true},"geolocation":{"country":"US"}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"f0545a23-5f6d-4b4b-a49c-1add6b248cc6":{"description":"OK","content":{"text/plain":{"schema":{"required":["id","object","status","source_id","auth_method","auth_credentials","persistence","geolocation","external_id","created_at","updated_at","request_id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the credential, prefixed with `cred_`.","pattern":"^cred_","example":"cred_AbC123xYz456","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","description":"Always `credential`.","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"status":{"type":"string","description":"Credential status: `unverified`, `verified`, `invalid`, or `deleted`.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"source_id":{"type":"string","description":"The source this credential authenticates against. Prefixed with `src_`.","isRequired":true,"uniqueKey":"source_id","typeLabel":"string"},"auth_method":{"type":"string","description":"Authentication method: `username_password`, `username`, `source_fields`, `google_sso`, `apple_sso`, or `none`.","isRequired":true,"uniqueKey":"auth_method","typeLabel":"string"},"auth_credentials":{"oneOf":[{"type":"null","description":"Summary of stored credentials. Sensitive values are not returned.","isRequired":true,"uniqueKey":"auth_credentials.oneOf.0","typeLabel":"null"},{"type":"object","description":"Summary of stored credentials. Sensitive values are not returned.","properties":{"username":{"oneOf":[{"type":"null","description":"The username associated with this credential, if applicable.","uniqueKey":"auth_credentials.oneOf.1.username.oneOf.0","typeLabel":"null"},{"type":"string","description":"The username associated with this credential, if applicable.","uniqueKey":"auth_credentials.oneOf.1.username.oneOf.1","typeLabel":"string"}],"uniqueKey":"auth_credentials.oneOf.1.username","typeLabel":"null | string"},"email":{"oneOf":[{"type":"null","description":"The Google or Apple Account email, for `google_sso` and `apple_sso`.","uniqueKey":"auth_credentials.oneOf.1.email.oneOf.0","typeLabel":"null"},{"type":"string","description":"The Google or Apple Account email, for `google_sso` and `apple_sso`.","uniqueKey":"auth_credentials.oneOf.1.email.oneOf.1","typeLabel":"string"}],"uniqueKey":"auth_credentials.oneOf.1.email","typeLabel":"null | string"},"source_fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"auth_credentials.oneOf.1.source_fields.additionalProperties","typeLabel":"string"},"description":"Non-tokenized `source_fields` returned as key/value pairs in the clear (for example, `{ \"company_id\": \"ACME-4412\" }`). Tokenized source fields are dropped from this map and named in `tokenized` instead. Omitted when empty.","uniqueKey":"auth_credentials.oneOf.1.source_fields","typeLabel":"object"},"tokenized":{"type":"array","items":{"type":"string","uniqueKey":"auth_credentials.oneOf.1.tokenized.items.[INDEX]","typeLabel":"string"},"description":"Names of the source fields whose values were vaulted. Their values never appear in `source_fields` and cannot be read back through the API. Omitted when nothing was tokenized.","uniqueKey":"auth_credentials.oneOf.1.tokenized","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"auth_credentials.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"auth_credentials","typeLabel":"null | object"},"persistence":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether persistence is enabled for this credential.","isRequired":true,"uniqueKey":"persistence.enabled","typeLabel":"boolean"}},"description":"Persistence settings for this credential.","isRequired":true,"uniqueKey":"persistence","typeLabel":"object"},"geolocation":{"oneOf":[{"type":"object","description":"Country this credential's task runs come from. `null` when unset, and Deck picks.","required":["country"],"properties":{"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code, in uppercase.","example":"US","isRequired":true,"uniqueKey":"geolocation.oneOf.0.country","typeLabel":"string"}},"isRequired":true,"uniqueKey":"geolocation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Country this credential's task runs come from. `null` when unset, and Deck picks.","isRequired":true,"uniqueKey":"geolocation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"geolocation","typeLabel":"object | null"},"external_id":{"oneOf":[{"type":"null","description":"External identifier from your system, if set.","isRequired":true,"uniqueKey":"external_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"External identifier from your system, if set.","isRequired":true,"uniqueKey":"external_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"external_id","typeLabel":"null | string"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the resource was created.","example":"2026-08-24T12:00:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the resource was last updated.","example":"2026-08-24T12:00:00Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"request_id":{"type":"string","description":"Unique identifier for the API request. Include this when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cred_AbC123xYz456","object":"\u003cstring>","status":"\u003cstring>","source_id":"\u003cstring>","auth_method":"\u003cstring>","auth_credentials":{"username":"\u003cstring>","email":"\u003cstring>","source_fields":{},"tokenized":["\u003cstring>"]},"persistence":{"enabled":true},"geolocation":{"country":"US"},"external_id":"\u003cstring>","created_at":"2026-08-24T12:00:00Z","updated_at":"2026-08-24T12:00:00Z","request_id":"\u003cstring>"}}},"exampleType":"generated"},"application/json":{"schema":{"required":["id","object","status","source_id","auth_method","auth_credentials","persistence","geolocation","external_id","created_at","updated_at","request_id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the credential, prefixed with `cred_`.","pattern":"^cred_","example":"cred_AbC123xYz456","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","description":"Always `credential`.","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"status":{"type":"string","description":"Credential status: `unverified`, `verified`, `invalid`, or `deleted`.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"source_id":{"type":"string","description":"The source this credential authenticates against. Prefixed with `src_`.","isRequired":true,"uniqueKey":"source_id","typeLabel":"string"},"auth_method":{"type":"string","description":"Authentication method: `username_password`, `username`, `source_fields`, `google_sso`, `apple_sso`, or `none`.","isRequired":true,"uniqueKey":"auth_method","typeLabel":"string"},"auth_credentials":{"oneOf":[{"type":"null","description":"Summary of stored credentials. Sensitive values are not returned.","isRequired":true,"uniqueKey":"auth_credentials.oneOf.0","typeLabel":"null"},{"type":"object","description":"Summary of stored credentials. Sensitive values are not returned.","properties":{"username":{"oneOf":[{"type":"null","description":"The username associated with this credential, if applicable.","uniqueKey":"auth_credentials.oneOf.1.username.oneOf.0","typeLabel":"null"},{"type":"string","description":"The username associated with this credential, if applicable.","uniqueKey":"auth_credentials.oneOf.1.username.oneOf.1","typeLabel":"string"}],"uniqueKey":"auth_credentials.oneOf.1.username","typeLabel":"null | string"},"email":{"oneOf":[{"type":"null","description":"The Google or Apple Account email, for `google_sso` and `apple_sso`.","uniqueKey":"auth_credentials.oneOf.1.email.oneOf.0","typeLabel":"null"},{"type":"string","description":"The Google or Apple Account email, for `google_sso` and `apple_sso`.","uniqueKey":"auth_credentials.oneOf.1.email.oneOf.1","typeLabel":"string"}],"uniqueKey":"auth_credentials.oneOf.1.email","typeLabel":"null | string"},"source_fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"auth_credentials.oneOf.1.source_fields.additionalProperties","typeLabel":"string"},"description":"Non-tokenized `source_fields` returned as key/value pairs in the clear (for example, `{ \"company_id\": \"ACME-4412\" }`). Tokenized source fields are dropped from this map and named in `tokenized` instead. Omitted when empty.","uniqueKey":"auth_credentials.oneOf.1.source_fields","typeLabel":"object"},"tokenized":{"type":"array","items":{"type":"string","uniqueKey":"auth_credentials.oneOf.1.tokenized.items.[INDEX]","typeLabel":"string"},"description":"Names of the source fields whose values were vaulted. Their values never appear in `source_fields` and cannot be read back through the API. Omitted when nothing was tokenized.","uniqueKey":"auth_credentials.oneOf.1.tokenized","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"auth_credentials.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"auth_credentials","typeLabel":"null | object"},"persistence":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether persistence is enabled for this credential.","isRequired":true,"uniqueKey":"persistence.enabled","typeLabel":"boolean"}},"description":"Persistence settings for this credential.","isRequired":true,"uniqueKey":"persistence","typeLabel":"object"},"geolocation":{"oneOf":[{"type":"object","description":"Country this credential's task runs come from. `null` when unset, and Deck picks.","required":["country"],"properties":{"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code, in uppercase.","example":"US","isRequired":true,"uniqueKey":"geolocation.oneOf.0.country","typeLabel":"string"}},"isRequired":true,"uniqueKey":"geolocation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Country this credential's task runs come from. `null` when unset, and Deck picks.","isRequired":true,"uniqueKey":"geolocation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"geolocation","typeLabel":"object | null"},"external_id":{"oneOf":[{"type":"null","description":"External identifier from your system, if set.","isRequired":true,"uniqueKey":"external_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"External identifier from your system, if set.","isRequired":true,"uniqueKey":"external_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"external_id","typeLabel":"null | string"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the resource was created.","example":"2026-08-24T12:00:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the resource was last updated.","example":"2026-08-24T12:00:00Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"request_id":{"type":"string","description":"Unique identifier for the API request. Include this when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cred_AbC123xYz456","object":"\u003cstring>","status":"\u003cstring>","source_id":"\u003cstring>","auth_method":"\u003cstring>","auth_credentials":{"username":"\u003cstring>","email":"\u003cstring>","source_fields":{},"tokenized":["\u003cstring>"]},"persistence":{"enabled":true},"geolocation":{"country":"US"},"external_id":"\u003cstring>","created_at":"2026-08-24T12:00:00Z","updated_at":"2026-08-24T12:00:00Z","request_id":"\u003cstring>"}}},"exampleType":"generated"},"text/json":{"schema":{"required":["id","object","status","source_id","auth_method","auth_credentials","persistence","geolocation","external_id","created_at","updated_at","request_id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the credential, prefixed with `cred_`.","pattern":"^cred_","example":"cred_AbC123xYz456","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","description":"Always `credential`.","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"status":{"type":"string","description":"Credential status: `unverified`, `verified`, `invalid`, or `deleted`.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"source_id":{"type":"string","description":"The source this credential authenticates against. Prefixed with `src_`.","isRequired":true,"uniqueKey":"source_id","typeLabel":"string"},"auth_method":{"type":"string","description":"Authentication method: `username_password`, `username`, `source_fields`, `google_sso`, `apple_sso`, or `none`.","isRequired":true,"uniqueKey":"auth_method","typeLabel":"string"},"auth_credentials":{"oneOf":[{"type":"null","description":"Summary of stored credentials. Sensitive values are not returned.","isRequired":true,"uniqueKey":"auth_credentials.oneOf.0","typeLabel":"null"},{"type":"object","description":"Summary of stored credentials. Sensitive values are not returned.","properties":{"username":{"oneOf":[{"type":"null","description":"The username associated with this credential, if applicable.","uniqueKey":"auth_credentials.oneOf.1.username.oneOf.0","typeLabel":"null"},{"type":"string","description":"The username associated with this credential, if applicable.","uniqueKey":"auth_credentials.oneOf.1.username.oneOf.1","typeLabel":"string"}],"uniqueKey":"auth_credentials.oneOf.1.username","typeLabel":"null | string"},"email":{"oneOf":[{"type":"null","description":"The Google or Apple Account email, for `google_sso` and `apple_sso`.","uniqueKey":"auth_credentials.oneOf.1.email.oneOf.0","typeLabel":"null"},{"type":"string","description":"The Google or Apple Account email, for `google_sso` and `apple_sso`.","uniqueKey":"auth_credentials.oneOf.1.email.oneOf.1","typeLabel":"string"}],"uniqueKey":"auth_credentials.oneOf.1.email","typeLabel":"null | string"},"source_fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"auth_credentials.oneOf.1.source_fields.additionalProperties","typeLabel":"string"},"description":"Non-tokenized `source_fields` returned as key/value pairs in the clear (for example, `{ \"company_id\": \"ACME-4412\" }`). Tokenized source fields are dropped from this map and named in `tokenized` instead. Omitted when empty.","uniqueKey":"auth_credentials.oneOf.1.source_fields","typeLabel":"object"},"tokenized":{"type":"array","items":{"type":"string","uniqueKey":"auth_credentials.oneOf.1.tokenized.items.[INDEX]","typeLabel":"string"},"description":"Names of the source fields whose values were vaulted. Their values never appear in `source_fields` and cannot be read back through the API. Omitted when nothing was tokenized.","uniqueKey":"auth_credentials.oneOf.1.tokenized","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"auth_credentials.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"auth_credentials","typeLabel":"null | object"},"persistence":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether persistence is enabled for this credential.","isRequired":true,"uniqueKey":"persistence.enabled","typeLabel":"boolean"}},"description":"Persistence settings for this credential.","isRequired":true,"uniqueKey":"persistence","typeLabel":"object"},"geolocation":{"oneOf":[{"type":"object","description":"Country this credential's task runs come from. `null` when unset, and Deck picks.","required":["country"],"properties":{"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code, in uppercase.","example":"US","isRequired":true,"uniqueKey":"geolocation.oneOf.0.country","typeLabel":"string"}},"isRequired":true,"uniqueKey":"geolocation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Country this credential's task runs come from. `null` when unset, and Deck picks.","isRequired":true,"uniqueKey":"geolocation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"geolocation","typeLabel":"object | null"},"external_id":{"oneOf":[{"type":"null","description":"External identifier from your system, if set.","isRequired":true,"uniqueKey":"external_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"External identifier from your system, if set.","isRequired":true,"uniqueKey":"external_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"external_id","typeLabel":"null | string"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the resource was created.","example":"2026-08-24T12:00:00Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of when the resource was last updated.","example":"2026-08-24T12:00:00Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"request_id":{"type":"string","description":"Unique identifier for the API request. Include this when contacting support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"cred_AbC123xYz456","object":"\u003cstring>","status":"\u003cstring>","source_id":"\u003cstring>","auth_method":"\u003cstring>","auth_credentials":{"username":"\u003cstring>","email":"\u003cstring>","source_fields":{},"tokenized":["\u003cstring>"]},"persistence":{"enabled":true},"geolocation":{"country":"US"},"external_id":"\u003cstring>","created_at":"2026-08-24T12:00:00Z","updated_at":"2026-08-24T12:00:00Z","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"74165566-0a24-4aaf-9ab5-46e3f593f377":{"description":"Bad request — validation error or malformed input.","content":{"application/json":{"schema":{"required":["errors"],"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"description":"Validation errors grouped by field name.","isRequired":true,"uniqueKey":"errors","typeLabel":"object"},"type":{"oneOf":[{"type":"null","description":"RFC 9110 problem type URI.","uniqueKey":"type.oneOf.0","typeLabel":"null"},{"type":"string","description":"RFC 9110 problem type URI.","uniqueKey":"type.oneOf.1","typeLabel":"string"}],"uniqueKey":"type","typeLabel":"null | string"},"title":{"oneOf":[{"type":"null","description":"Short summary of the validation failure.","uniqueKey":"title.oneOf.0","typeLabel":"null"},{"type":"string","description":"Short summary of the validation failure.","uniqueKey":"title.oneOf.1","typeLabel":"string"}],"uniqueKey":"title","typeLabel":"null | string"},"status":{"oneOf":[{"type":"null","description":"HTTP status code.","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"null"},{"type":"integer","description":"HTTP status code.","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"integer\u003cint32>"}],"uniqueKey":"status","typeLabel":"null | integer\u003cint32>"},"traceId":{"oneOf":[{"type":"null","description":"Request trace identifier.","uniqueKey":"traceId.oneOf.0","typeLabel":"null"},{"type":"string","description":"Request trace identifier.","uniqueKey":"traceId.oneOf.1","typeLabel":"string"}],"uniqueKey":"traceId","typeLabel":"null | string"}},"description":"Validation error returned for malformed requests (HTTP 400).","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":{},"type":"\u003cstring>","title":"\u003cstring>","status":123,"traceId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8432be81-e3f6-408c-b665-f3a40e32816c":{"description":"Unauthorized.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"de33ddae-d06b-471e-8aa2-b8321afc00fd":{"description":"Forbidden.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8981b626-d179-47dd-ab47-a0d2e3893646":{"description":"Not found — the requested resource does not exist.","content":{"application/json":{"schema":{"required":["errors","request_id"],"type":"object","properties":{"errors":{"type":"array","items":{"required":["type","code","message"],"type":"object","properties":{"type":{"type":"string","description":"Error category (e.g. `source`, `auth`, `task`, `rate_limit`). Determines the class of failure.","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code. Use this for programmatic handling.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not rely on this for logic — it may change.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"null","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"null"},{"type":"string","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"string"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"null | string"}},"description":"Error details for a failed task run. Same structure as API-level errors.","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"One or more errors that describe what went wrong.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Unique identifier for this request, useful for tracing.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"description":"Standard error response.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}],"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1ef19a83-b7c6-41f3-b1b1-f47494729a57":{"description":"Conflict — the request is valid but cannot be completed in the current state. Also returned when an `Idempotency-Key` is reused with different request parameters (`idempotency_error`).","content":{"application/json":{"schema":{"required":["errors","request_id"],"type":"object","properties":{"errors":{"type":"array","items":{"required":["type","code","message"],"type":"object","properties":{"type":{"type":"string","description":"Error category (e.g. `source`, `auth`, `task`, `rate_limit`). Determines the class of failure.","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code. Use this for programmatic handling.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not rely on this for logic — it may change.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"null","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"null"},{"type":"string","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"string"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"null | string"}},"description":"Error details for a failed task run. Same structure as API-level errors.","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"One or more errors that describe what went wrong.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Unique identifier for this request, useful for tracing.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"description":"Standard error response.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}],"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e7064fce-eaf2-49ad-8ae9-1ac7d002164c":{"description":"Unprocessable content — the request body is understood but contains invalid values.","content":{"application/json":{"schema":{"required":["errors","request_id"],"type":"object","properties":{"errors":{"type":"array","items":{"required":["type","code","message"],"type":"object","properties":{"type":{"type":"string","description":"Error category (e.g. `source`, `auth`, `task`, `rate_limit`). Determines the class of failure.","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code. Use this for programmatic handling.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not rely on this for logic — it may change.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"null","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"null"},{"type":"string","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"string"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"null | string"}},"description":"Error details for a failed task run. Same structure as API-level errors.","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"One or more errors that describe what went wrong.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Unique identifier for this request, useful for tracing.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"description":"Standard error response.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}],"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d9c28127-eccb-41ab-91a3-34f1ac771db6":{"description":"Too many requests — the organization-wide API rate limit was exceeded (`rate_limit_exceeded`). Retry with exponential backoff.","content":{"application/json":{"schema":{"required":["errors","request_id"],"type":"object","properties":{"errors":{"type":"array","items":{"required":["type","code","message"],"type":"object","properties":{"type":{"type":"string","description":"Error category (e.g. `source`, `auth`, `task`, `rate_limit`). Determines the class of failure.","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code. Use this for programmatic handling.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not rely on this for logic — it may change.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"null","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"null"},{"type":"string","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"string"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"null | string"}},"description":"Error details for a failed task run. Same structure as API-level errors.","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"One or more errors that describe what went wrong.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Unique identifier for this request, useful for tracing.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"description":"Standard error response.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}],"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d7bdeaa5-3aa2-423a-a3ce-f8df092e5754":{"description":"Internal server error.","content":{"application/json":{"schema":{"required":["errors","request_id"],"type":"object","properties":{"errors":{"type":"array","items":{"required":["type","code","message"],"type":"object","properties":{"type":{"type":"string","description":"Error category (e.g. `source`, `auth`, `task`, `rate_limit`). Determines the class of failure.","isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code. Use this for programmatic handling.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. Do not rely on this for logic — it may change.","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"null","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"null"},{"type":"string","description":"The input field that caused the error, when applicable.","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"string"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"null | string"}},"description":"Error details for a failed task run. Same structure as API-level errors.","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"One or more errors that describe what went wrong.","isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Unique identifier for this request, useful for tracing.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"description":"Standard error response.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}],"request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"70a6cd60-7554-4caa-8414-b07034a86562":{"BearerAuth":{"type":"http","description":"Secret key (sk_live_...)","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"11088669-f0e3-446e-9f56-9d49b375b996":{"url":"https://api.deck.co/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Secret key (sk_live_...)","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret key (sk_live_...)","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/v2.json"},"subdomain":"decksoftwareinc","siteName":"Deck Docs","title":"Update a credential - Deck Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T16:03:55.289Z","originalFileLocation":"api-reference/credentials/update-a-credential.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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 credential\u0026#x27;s authentication details or external ID. Only the fields you include in the request body are updated.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Deck Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_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/decksoftwareinc/DmQKfMV4zw6ETaNX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a credential - Deck Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a credential\u0026#x27;s authentication details or external ID. Only the fields you include in the request body are updated.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Deck Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.deck.co/api-reference/credentials/update-a-credential\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://decksoftwareinc.mintlify.site/_mintlify/api/og/v2?division=Credentials\u0026amp;title=Update+a+credential\u0026amp;description=Updates+a+credential%27s+authentication+details+or+external+ID.+Only+the+fields+you+include+in+the+request+body+are+updated.\u0026amp;theme=94e340d8b0fe60995d375a96\u0026amp;signature=cf3410f4484199e966059feaad6cd819404b42667c66ab98a38dbdb37a4bd527\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a credential - Deck Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a credential\u0026#x27;s authentication details or external ID. Only the fields you include in the request body are updated.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://decksoftwareinc.mintlify.site/_mintlify/api/og/v2?division=Credentials\u0026amp;title=Update+a+credential\u0026amp;description=Updates+a+credential%27s+authentication+details+or+external+ID.+Only+the+fields+you+include+in+the+request+body+are+updated.\u0026amp;theme=94e340d8b0fe60995d375a96\u0026amp;signature=cf3410f4484199e966059feaad6cd819404b42667c66ab98a38dbdb37a4bd527\">\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/decksoftwareinc/DmQKfMV4zw6ETaNX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Deck Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#60917e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.deck.co/api-reference/credentials/update-a-credential\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/credentials/update-a-credential.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.deck.co/#organization\",\"name\":\"Deck Docs\",\"url\":\"https://docs.deck.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/decksoftwareinc/qU-Ph3TxWRaVaZ4z/logo/light.svg?fit=max\u0026auto=format\u0026n=qU-Ph3TxWRaVaZ4z\u0026q=85\u0026s=7219c0996a361a0efa1315710acaece8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.deck.co#website\",\"name\":\"Deck Docs\",\"url\":\"https://docs.deck.co\",\"publisher\":{\"@id\":\"https://docs.deck.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.deck.co/api-reference/credentials/update-a-credential#webpage\",\"url\":\"https://docs.deck.co/api-reference/credentials/update-a-credential\",\"name\":\"Update a credential\",\"description\":\"Updates a credential's authentication details or external ID. Only the fields you include in the request body are updated.\",\"dateModified\":\"2026-11-10T16:03:55.289Z\",\"isPartOf\":{\"@id\":\"https://docs.deck.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.deck.co/api-reference/credentials/update-a-credential#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.deck.co/api-reference/credentials/update-a-credential#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Credentials\",\"item\":\"https://docs.deck.co/api-reference/credentials/create-a-credential\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a credential\",\"item\":\"https://docs.deck.co/api-reference/credentials/update-a-credential\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.deck.co/api-reference/credentials/update-a-credential#apireference\",\"headline\":\"Update a credential\",\"name\":\"Update a credential\",\"description\":\"Updates a credential's authentication details or external ID. Only the fields you include in the request body are updated.\",\"url\":\"https://docs.deck.co/api-reference/credentials/update-a-credential\",\"mainEntityOfPage\":{\"@id\":\"https://docs.deck.co/api-reference/credentials/update-a-credential#webpage\"},\"dateModified\":\"2026-11-10T16:03:55.289Z\",\"publisher\":{\"@id\":\"https://docs.deck.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.deck.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Deck Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Deck Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/credentials/update-a-credential.md","siteName":"Deck Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Agents","pages":[{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /agents","href":"/api-reference/agents/create-an-agent"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Retrieve an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /agents/{agent_id}","href":"/api-reference/agents/retrieve-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /agents/{agent_id}","href":"/api-reference/agents/update-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /agents/{agent_id}","href":"/api-reference/agents/delete-an-agent"}]},{"group":"Sources","pages":[{"title":"Create a source","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /sources","href":"/api-reference/sources/create-a-source"},{"title":"List sources","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /sources","href":"/api-reference/sources/list-sources"},{"title":"Retrieve a source","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /sources/{source_id}","href":"/api-reference/sources/retrieve-a-source"},{"title":"Update a source","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /sources/{source_id}","href":"/api-reference/sources/update-a-source"},{"title":"Reset a source","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /sources/{source_id}/reset","href":"/api-reference/sources/reset-a-source"},{"title":"Delete a source","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /sources/{source_id}","href":"/api-reference/sources/delete-a-source"}]},{"group":"Tasks","pages":[{"title":"Create a task","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /tasks","href":"/api-reference/tasks/create-a-task"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Retrieve a task","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /tasks/{task_id}","href":"/api-reference/tasks/retrieve-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /tasks/{task_id}","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /tasks/{task_id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Run a task","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /tasks/{task_id}/run","href":"/api-reference/tasks/run-a-task"},{"title":"Reset a task","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /tasks/{task_id}/reset","href":"/api-reference/tasks/reset-a-task"}]},{"group":"Task Runs","pages":[{"title":"Retrieve a task run","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /task-runs/{run_id}","href":"/api-reference/task-runs/retrieve-a-task-run"},{"title":"List task runs","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /task-runs","href":"/api-reference/task-runs/list-task-runs"},{"title":"List task run storage items","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /task-runs/{run_id}/storage","href":"/api-reference/task-runs/list-task-run-storage-items"},{"title":"List task run screenshots","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /task-runs/{run_id}/screenshots","href":"/api-reference/task-runs/list-task-run-screenshots"},{"title":"Cancel a task run","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /task-runs/{run_id}/cancel","href":"/api-reference/task-runs/cancel-a-task-run"},{"title":"Rerun a task run","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /task-runs/{run_id}/rerun","href":"/api-reference/task-runs/rerun-a-task-run"},{"title":"Submit interaction input","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /task-runs/{run_id}/interaction","href":"/api-reference/task-runs/submit-interaction-input"}]},{"group":"Credentials","pages":[{"title":"Create a credential","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /credentials","href":"/api-reference/credentials/create-a-credential"},{"title":"List credentials","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /credentials","href":"/api-reference/credentials/list-credentials"},{"title":"Retrieve a credential","description":"Returns a single credential by ID.","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /credentials/{credential_id}","href":"/api-reference/credentials/retrieve-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /credentials/{credential_id}","href":"/api-reference/credentials/update-a-credential"},{"title":"Delete a credential","description":"Permanently deletes a credential.","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /credentials/{credential_id}","href":"/api-reference/credentials/delete-a-credential"}]},{"group":"Sessions","pages":[{"title":"Start a session","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /sessions","href":"/api-reference/sessions/start-a-session"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Retrieve a session","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /sessions/{session_id}","href":"/api-reference/sessions/retrieve-a-session"},{"title":"End a session","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /sessions/{session_id}/end","href":"/api-reference/sessions/end-a-session"}]},{"group":"Storage","pages":[{"title":"Retrieve a storage item","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /storage/{storage_id}","href":"/api-reference/storage/retrieve-a-storage-item"},{"title":"Delete a storage item","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /storage/{storage_id}","href":"/api-reference/storage/delete-a-storage-item"}]},{"group":"Triggers","pages":[{"title":"Create a trigger","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /triggers","href":"/api-reference/triggers/create-a-trigger"},{"title":"List triggers","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /triggers","href":"/api-reference/triggers/list-triggers"},{"title":"Retrieve a trigger","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /triggers/{trigger_id}","href":"/api-reference/triggers/retrieve-a-trigger"},{"title":"Update a trigger","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /triggers/{trigger_id}","href":"/api-reference/triggers/update-a-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /triggers/{trigger_id}","href":"/api-reference/triggers/delete-a-trigger"},{"title":"List trigger credentials","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /triggers/{trigger_id}/credentials","href":"/api-reference/triggers/list-trigger-credentials"}]},{"group":"Workflows","pages":[{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Retrieve a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /workflows/{workflow_id}","href":"/api-reference/workflows/retrieve-a-workflow"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /workflows/{workflow_id}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /workflows/{workflow_id}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"Run a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /workflows/{workflow_id}/run","href":"/api-reference/workflows/run-a-workflow"},{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /workflow-runs","href":"/api-reference/workflow-runs/list-workflow-runs"},{"title":"Retrieve a workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /workflow-runs/{workflow_run_id}","href":"/api-reference/workflow-runs/retrieve-a-workflow-run"},{"title":"Cancel a workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /workflow-runs/{workflow_run_id}/cancel","href":"/api-reference/workflow-runs/cancel-a-workflow-run"},{"title":"Rerun a workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /workflow-runs/{workflow_run_id}/rerun","href":"/api-reference/workflow-runs/rerun-a-workflow-run"}]},{"group":"Event Destinations","pages":[{"title":"Create an event destination","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /event-destinations","href":"/api-reference/event-destinations/create-an-event-destination"},{"title":"List event destinations","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /event-destinations","href":"/api-reference/event-destinations/list-event-destinations"},{"title":"Retrieve an event destination","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /event-destinations/{destination_id}","href":"/api-reference/event-destinations/retrieve-an-event-destination"},{"title":"Update an event destination","deprecated":null,"version":null,"openapi":"/api-reference/v2.json patch /event-destinations/{destination_id}","href":"/api-reference/event-destinations/update-an-event-destination"},{"title":"Delete an event destination","deprecated":null,"version":null,"openapi":"/api-reference/v2.json delete /event-destinations/{destination_id}","href":"/api-reference/event-destinations/delete-an-event-destination"},{"title":"Send a test event to a destination","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /event-destinations/{destination_id}/test","href":"/api-reference/event-destinations/send-a-test-event-to-a-destination"},{"title":"List event deliveries","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /event-destinations/{destination_id}/event-deliveries","href":"/api-reference/event-destinations/list-event-deliveries"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /events","href":"/api-reference/events/list-events"},{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /events/{event_id}","href":"/api-reference/events/retrieve-an-event"},{"title":"List event types","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /event-types","href":"/api-reference/events/list-event-types"}]},{"group":"Components","pages":[{"title":"Create a session token","deprecated":null,"version":null,"openapi":"/api-reference/v2.json post /token","href":"/api-reference/components/create-a-session-token"}]},{"group":"Platform","pages":[{"title":"Retrieve the static IP range","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /static-ips","href":"/api-reference/platform/retrieve-the-static-ip-range"}]},{"group":"Test","pages":[{"title":"Test your API key","deprecated":null,"version":null,"openapi":"/api-reference/v2.json get /test","href":"/api-reference/test/test-your-api-key"}]}]},{"tab":"Changelog","href":"https://deck.co/changelog"}]},"basePath":"","title":"Update a credential - Deck Docs","buildId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","deploymentId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-NXj-Rqjv.js","utils-m0thOP-_.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D13EKcfm.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema--XTdfsEb.js","snippetPresets-D3s4lmAH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-ChURybxL.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DL8CiXq2.js","shallow-DI2-YB2E.js","getApiPlaygroundDisplay-DxbW7b_y.js","CodeSnippet-CiNYS0pP.js","CodeSnippets-BT87bThu.js","Page-DSpdRuhM.js","getPastedJson-F_g_IrFQ.js","icon-CCIG5BAs.js","MethodPill-DY3E0jwx.js","DuplicateIcon-BN88xnEg.js","createIcon-VCCc5HO5.js","DynamicMarkdown-CaSwclgK.js","SectionHeading-DXV8nWhc.js","axios-vUo_bRtp.js","Markdown-CV32Re6G.js","clsx-5ydLOnhV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-pFDdfjRe.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BUGO5bPJ.js"]}