Use custom fields with vendors

You can include custom fields when creating or updating vendors. These fields must first be created via the Vanta UI on this page https://app.vanta.com/c/vantaroo/vendors/settings/custom-vendor-fields

Once those custom fields are created, you can attach them to a vendor either when creating a vendor or updating a vendor.

Create a Vendor with Custom Fields

Endpoint:

POST /vendors

curl --location --request POST 'https://api.vanta.com/v1/vendors' \
--header 'Authorization: Bearer vat_YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "vendorName": "Acme Corp",
  "vendorWebsite": "https://acmecorp.com",
  "vendorCategory": "Cloud Storage",
  "customFields": [{
    "label": "Money", // Make sure this matches a custom field name above
    "value": 10 // Make sure this matches the custom field type above
  }]
}'

Update an Existing Vendor with Custom Fields

Endpoint:

PATCH /vendors/:vendorId

curl --location --request PATCH 'https://api.vanta.com/v1/vendors/VENDOR_ID_HERE' \
--header 'Authorization: Bearer vat_YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customFields": [{
    "label": "contractEndDate", // example using Date type
    "value": "2026-01-01T00:00:00.000Z"
  }]
}'