PATCH
/v1/workspace/vendors/{id}Change a vendor
Admin only, and a whole replacement rather than a merge. Setting active to false RETIRES the vendor: it keeps the deals that named it readable, stops it filling any new slot, and takes it out of the contract-currency check.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
Request body
application/jsonrequiredbodyoptional
paramsoptional
queryobjectoptional
Responses
200application/json
the action's answer
{
"data": {
"active": true,
"contactEmail": "string",
"contactName": "string",
"contactPhone": "string",
"contractEndsOn": "string",
"contractStartedOn": "string",
"createdAt": "string",
"createdBy": 1,
"documents": [
{
"fileId": "",
"name": "string",
"pinnedAt": "string",
"pinnedBy": "string"
}
],
"id": "",
"kind": "string",
"name": "string",
"notes": "string",
"updatedAt": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired