API Reference

Update Client Vendor

patch
https://api.scalepad.com/controlmap/v1/clients//vendors/

Updates the supplied vendor fields. At least one field is required.

Update rules

  • Omitted fields remain unchanged. Null clears owner_email; other nulls leave values unchanged.
  • Use client lookup names for type, status, tier, tags and manual risk.
  • Tags replace user tags; an empty array clears them. System tags are retained.
  • Supplying manual_risk enables the risk-score override.
  • After changing code, use the returned code. Update contacts through their endpoint.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Client UUID or tenant_id accessible to the API key.

Accepts either the client UUID or the client's tenant_id.

string
required

Public vendor code in this client.

Body Params

Vendor fields to update. Omitted fields remain unchanged.

string
length between 0 and 45

Display name.

string
length between 0 and 65535

Vendor description. On PATCH, omit or pass null to keep the current description.

string | null
^[\s\S]*\S[\s\S]*$

Vendor type configured for the client. Names are matched case-insensitively. On PATCH, omit or pass null to keep the current type.

string | null
^[\s\S]*\S[\s\S]*$

Vendor status configured for the client. Names are matched case-insensitively. On PATCH, omit or pass null to keep the current status.

string | null
^[\s\S]*\S[\s\S]*$

Enabled vendor tier configured for the client. Names are matched case-insensitively. On PATCH, omit or pass null to keep the current tier.

string | null
^[\s\S]*\S[\s\S]*$

Manual risk rating configured for the client. Supplying a rating enables the override. Omit or pass null to leave it unchanged.

tags
array of strings | null

Existing user tag names. Replaces user tags; [] clears them. Omit or pass null to leave them unchanged. System tags are not changed.

tags
string | null
^[\s\S]*\S[\s\S]*$

Email of an existing client user. Omission keeps the owner; passing null clears it.

string
length between 0 and 45
^VND-[1-9][0-9]*$

New vendor code. Must be unique in the client. Use the current code in the URL and the returned code for later requests.

Responses

Updated 1 day ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?