Skip to main content
PATCH
/
credentials
/
{credential_id}
Update a credential
curl --request PATCH \
  --url https://api.deck.co/v2/credentials/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auth_credentials": "<unknown>",
  "external_id": "<string>"
}
'
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "source_id": "<string>",
  "auth_method": "<string>",
  "auth_credentials": {
    "username": "<string>",
    "key": "<string>"
  },
  "external_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

​
credential_id
string
required

Unique identifier for the credential (prefixed with cred_).

Body

Request body for updating a credential. Only include fields you want to change.

​
auth_credentials
any

Updated credentials payload.

​
external_id
null | string

Updated external identifier. Set to null to remove the mapping.

Response

OK

​
id
string
required

Unique identifier for the credential, prefixed with cred_.

​
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 or none.

​
auth_credentials
object
required

Summary of stored credentials. Sensitive values are not returned.

​
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.

​
updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

​
request_id
string
required

Unique identifier for the API request. Include this when contacting support.