Vendors

Update a vendor

Changed on

Partially updates an existing vendor. Only provided fields are updated. Review and scorecard fields can be explicitly set to null to clear them. Required fields (vendor_name, vendor_provides, website, vendor_contact_person) are only updated if they have a non-empty value. Records field-level changes in change history, fires automation triggers (vendor_updated), and sends in-app notifications when assignee or reviewer changes.

patch/vendors/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/vendors/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Vendor ID

Request body

vendor_namestring
vendor_providesstring
assigneeinteger
websitestring
vendor_contact_personstring
review_resultstring nullable
review_status'Not started' | 'In review' | 'Reviewed' | 'Requires follow-up' nullable
reviewerinteger nullable
review_datestring date-time nullable
order_nointeger
projectsinteger[]
data_sensitivity'None' | 'Internal only' | 'Personally identifiable information (PII)' | 'Financial data' | 'Health data (e.g. HIPAA)' | 'Model weights or AI assets' | 'Other sensitive data' nullable
business_criticality'Low (vendor supports non-core functions)' | 'Medium (affects operations but is replaceable)' | 'High (critical to core services or products)' nullable
past_issues'None' | 'Minor incident (e.g. small delay, minor bug)' | 'Major incident (e.g. data breach, legal issue)' nullable
regulatory_exposure'None' | 'GDPR (EU)' | 'HIPAA (US)' | 'SOC 2' | 'ISO 27001' | 'EU AI act' | 'CCPA (california)' | 'Other' nullable
risk_scoreinteger nullable

Response

Vendor updated successfully

messagestring

Example response

{
  "message": "Accepted",
  "data": {
    "id": 42,
    "vendor_name": "Acme Corp",
    "vendor_provides": "Cloud hosting services",
    "assignee": 5,
    "website": "https://acme.example.com",
    "vendor_contact_person": "Jane Doe"
  }
}

Changes