Vanta Developer Console
API Reference

Update vendor by ID

patch
https://api.vanta.com/v1/vendors/

Update vendor.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
length ≤ 2000

Display name of the vendor.

string | null

The url of the vendor's website.

string | null

Name of the external account manager for this vendor.

string
length ≤ 2000

Email of the external account manager for this vendor.

string | null

The Vanta user ID of the security owner of this vendor.

string | null

Services provided by the vendor.

string | null

Miscellaneous notes about the vendor

string | null

The Vanta user ID of the business owner of this vendor.

date-time | null

When the contract with the vendor is up for renewal.

date-time | null

When the contract with the vendor is up for renewal.

date-time | null

When the contract with the vendor was terminated.

boolean

Whether or not auditors can view this vendor.

authDetails
object

The authentication details about the vendor.

string
enum

The current status of the vendor.

Allowed:
string

The vendor's category.

string | null
enum

The risk level of a vendor:

  • CRITICAL: The vendor has a critical security risk
  • HIGH: The vendor has a high security risk
  • MEDIUM: The vendor has a medium security risk
  • LOW: The vendor has a low security risk
  • UNSCORED: The vendor has not been given a risk level
Allowed:
string
enum

The residual risk level of the vendor.

Allowed:
riskAttributeIds
array of strings

A list of risk attribute ids the vendor has been assigned.

riskAttributeIds
string | null
enum

The vendor's headquarters.

contractAmount
object | null

The contract amount for the vendor.

customFields
array of objects

The custom fields for the vendor. For more information on how to set custom fields via the API, visit https://developer.vanta.com/docs/use-custom-fields-with-vendors

customFields
frameworkScope
object

Framework scoping configuration for this vendor. Determines which compliance frameworks the vendor applies to.

Response

Updated about 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago