Vendors

Create a vendor

Changed on

Creates a new vendor in the authenticated user's organization. Validates required fields, checks demo restrictions, associates projects via the vendors_projects join table, records creation in change history, fires automation triggers (vendor_added), and sends in-app assignment notifications to assignee and reviewer.

post/vendors

Request

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

Request body

vendor_namestring required

Name of the vendor (required, non-empty)

vendor_providesstring required

What the vendor provides (required, non-empty)

assigneeinteger required

User ID of the assigned owner (required, >= 1)

websitestring required

Vendor website URL (required, non-empty)

vendor_contact_personstring required

Name of the vendor contact (required, non-empty)

review_resultstring

Free-text review result summary

review_status'Not started' | 'In review' | 'Reviewed' | 'Requires follow-up'

Current review lifecycle status

reviewerinteger

User ID of the reviewer

review_datestring date-time

Date of the review (ISO 8601)

order_nointeger

Display order number

is_demoboolean

Mark as demo vendor

projectsinteger[]

Array of project IDs to associate

data_sensitivity'None' | 'Internal only' | 'Personally identifiable information (PII)' | 'Financial data' | 'Health data (e.g. HIPAA)' | 'Model weights or AI assets' | 'Other sensitive data'
business_criticality'Low (vendor supports non-core functions)' | 'Medium (affects operations but is replaceable)' | 'High (critical to core services or products)'
past_issues'None' | 'Minor incident (e.g. small delay, minor bug)' | 'Major incident (e.g. data breach, legal issue)'
regulatory_exposure'None' | 'GDPR (EU)' | 'HIPAA (US)' | 'SOC 2' | 'ISO 27001' | 'EU AI act' | 'CCPA (california)' | 'Other'
risk_scoreinteger

Computed risk score

Response

Vendor created successfully

messagestring

Example response

{
  "message": "Created",
  "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