Skip to main content
PATCH
Update a credential

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Headers

Idempotency-Key
string

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

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.

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.

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.

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.

persistence
object
required

Persistence settings for this credential.

geolocation
object | null
required

Country this credential's task runs come from. null when unset, and Deck picks.

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.