Credentials

Update a credential

Updates a credential's authentication details or external ID. Only the fields you include in the request body are updated.

patch/credentials/{credential_id}

Path parameters

credential_idstring required

Unique identifier for the credential (prefixed with cred_).

external_idstring nullable

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

idstring required

Unique identifier for the credential, prefixed with cred_.

objectstring required

Always credential.

statusstring required

Credential status: unverified, verified, invalid, or deleted.

source_idstring required

The source this credential authenticates against. Prefixed with src_.

auth_methodstring required

Authentication method: username_password, source_fields, or none.

external_idstring nullable required

External identifier from your system, if set.

created_atstring date-time required

ISO 8601 timestamp of when the resource was created.

updated_atstring date-time required

ISO 8601 timestamp of when the resource was last updated.

request_idstring required

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

No recorded changes to this endpoint across all 1 revision of this API.