Update vendor

Partially updates a vendor. Only provided fields will be updated. Supports both API key authentication (X-API-Key header) and session authentication (Bearer token or cookies).

PATCH /v1/vendors/{id}

Update vendor

cURL

curl --request PATCH \
  --url http://localhost:3333/v1/vendors/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "category": "cloud",
  "status": "not_assessed",
  "inherentProbability": "very_unlikely",
  "inherentImpact": "insignificant",
  "residualProbability": "very_unlikely",
  "residualImpact": "insignificant",
  "website": "<string>",
  "isSubProcessor": true,
  "assigneeId": "<string>"
}
'

200

{
  "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",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "[e-mail]"
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Vendor ID

Example:

"vnd_abc123def456"

Body

application/json

Vendor update data

name · string

Vendor name

description · string

Vendor description

category · enum<string>

Vendor category

Available options: cloud, infrastructure, software_as_a_service, finance, marketing, sales, hr, other

status · enum<string>

Assessment status

Available options: not_assessed, in_progress, assessed

inherentProbability · enum<string>

Inherent probability

Available options: very_unlikely, unlikely, possible, likely, very_likely

inherentImpact · enum<string>

Inherent impact

Available options: insignificant, minor, moderate, major, severe

residualProbability · enum<string>

Residual probability

Available options: very_unlikely, unlikely, possible, likely, very_likely

residualImpact · enum<string>

Residual impact

Available options: insignificant, minor, moderate, major, severe

website · string

Vendor website URL

isSubProcessor · boolean

Whether the vendor is a sub-processor

assigneeId · string

Assignee member ID

Response

200

application/json

Vendor updated successfully

id · string

Vendor ID

Example:

"vnd_abc123def456"

name · string

Vendor name

Example:

"CloudTech Solutions Inc."

description · string

Vendor description

Example:

"Cloud infrastructure provider offering AWS-like services including compute, storage, and networking solutions for enterprise customers."

category · enum<string>

Available options: cloud, infrastructure, software_as_a_service, finance, marketing, sales, hr, other

Example:

"cloud"

status · enum<string>

Available options: not_assessed, in_progress, assessed

Example:

"assessed"

inherentProbability · enum<string>

Available options: very_unlikely, unlikely, possible, likely, very_likely

Example:

"possible"

inherentImpact · enum<string>

Available options: insignificant, minor, moderate, major, severe

Example:

"moderate"

residualProbability · enum<string>

Available options: very_unlikely, unlikely, possible, likely, very_likely

Example:

"unlikely"

residualImpact · enum<string>

Available options: insignificant, minor, moderate, major, severe

Example:

"minor"

website · string | null

Example:

"https://www.cloudtechsolutions.com"

organizationId · string

Example:

"org_abc123def456"

assigneeId · string | null

ID of the user assigned to manage this vendor

Example:

"mem_abc123def456"

createdAt · string<date-time>

When the vendor was created

updatedAt · string<date-time>

When the vendor was last updated

authType · enum<string>

How the request was authenticated

Available options: api-key, session

authenticatedUser · object

User information (only for session auth)

Show child attributes