Vendors

Update vendor record

Changed on

Update vendor ownership, risk attributes, review metadata, and third-party compliance context for an organization.

patch/v1/vendors/{id}

Request

  • Base URL
    https://api.betayum.com
  • URL
    https://api.betayum.com/v1/vendors/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required
Example:vnd_abc123def456

Vendor ID

Request body

namestring

Vendor name

descriptionstring

Vendor description

category'cloud' | 'infrastructure' | 'software_as_a_service' | 'finance' | 'marketing' | 'sales' | 'hr' | 'other'

Vendor category

status'not_assessed' | 'in_progress' | 'assessed'

Assessment status

inherentProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'

Inherent probability

inherentImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'

Inherent impact

residualProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'

Residual probability

residualImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'

Residual impact

treatmentStrategy'accept' | 'avoid' | 'mitigate' | 'transfer'

Risk treatment strategy

treatmentStrategyDescriptionobject

Description of the treatment strategy

websitestring

Vendor website URL

isSubProcessorboolean

Whether the vendor is a sub-processor

assigneeIdstring

Assignee member ID

Example request

{
  "treatmentStrategy": "mitigate"
}

Response

Vendor updated successfully

idstring

Vendor ID

namestring

Vendor name

descriptionstring

Vendor description

category'cloud' | 'infrastructure' | 'software_as_a_service' | 'finance' | 'marketing' | 'sales' | 'hr' | 'other'
status'not_assessed' | 'in_progress' | 'assessed'
inherentProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'
inherentImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'
residualProbability'very_unlikely' | 'unlikely' | 'possible' | 'likely' | 'very_likely'
residualImpact'insignificant' | 'minor' | 'moderate' | 'major' | 'severe'
websitestring nullable
organizationIdstring
assigneeIdstring nullable

ID of the user assigned to manage this vendor

createdAtstring date-time

When the vendor was created

updatedAtstring date-time

When the vendor was last updated

authType'api-key' | 'session'

How the request was authenticated

Example response

{
  "id": "vnd_abc123def456",
  "name": "CloudTech Solutions Inc.",
  "description": "Cloud infrastructure provider offering AWS-like services including compute, storage, and networking solutions for enterprise customers.",
  "category": "cloud",
  "status": "assessed",
  "inherentProbability": "possible",
  "inherentImpact": "moderate",
  "residualProbability": "unlikely",
  "residualImpact": "minor",
  "website": "https://www.cloudtechsolutions.com",
  "organizationId": "org_abc123def456",
  "assigneeId": "mem_abc123def456",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "user@example.com"
  }
}

Changes

  • 2db21a9af7bdRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • ab25f417b60bRevision changes
    • info

      the request property default value other was removed

    • info

      the request property default value insignificant was removed

    • info

      the request property default value very_unlikely was removed

    • info

      the request property default value false was removed

    • info

      the request property default value insignificant was removed

    • info

      the request property default value very_unlikely was removed

    • info

      the request property default value not_assessed was removed