Sign in
Credentials

Update credential

Overwrites the stored credential data (e.g. username/password) while keeping the same credential_id.

post/v1/credentials/{credential_id}/update

Path parameters

credential_idstring required

The unique identifier of the credential to update

Example:cred_1234567890

The unique identifier of the credential to update

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Request body

namestring required

Name of the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

vault_type'bitwarden' | 'azure_vault' | 'custom'

Example request

{
  "name": "Amazon Login",
  "credential": {
    "password": "securepassword123",
    "username": "user@example.com",
    "totp": "JBSWY3DPEHPK3PXP",
    "totp_identifier": "user@example.com"
  }
}

Response

Successful Response

credential_idstring required

Unique identifier for the credential

credential_type'password' | 'credit_card' | 'secret' required

Type of credential stored in the system.

namestring required

Name of the credential

vault_type'bitwarden' | 'azure_vault' | 'custom'
browser_profile_idstring nullable

Browser profile ID linked to this credential

tested_urlstring nullable

Login page URL used during the credential test

user_contextstring nullable

User-provided context describing the login sequence (e.g., 'click SSO button first')

save_browser_session_intentboolean nullable

Whether the user intends to save a browser session, regardless of test outcome

Example response

{
  "credential_id": "cred_1234567890",
  "credential": {
    "username": "user@example.com",
    "totp_identifier": "user@example.com"
  },
  "name": "Amazon Login"
}

Changes