API Reference

Create Client Vendor

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

Creates a vendor for the client. Only name is required.

Supply both contact fields to create a primary contact. Use client lookup names for vendor type, status, tier, tags and manual risk, and an existing client user email for the owner. The vendor receives a code and the default Quick Assessment; no Risk Assessment is assigned or sent.

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.

Body Params

Vendor details to create. Only name is required.

string
required
length between 1 and 45
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 to assign as the owner. On PATCH, omission keeps the owner and passing null clears it.

string | null

Optional primary contact email. Must be a valid, nonblank email when supplied.

string | null

Optional primary contact name. Must not be blank when supplied.

string
length between 0 and 20

Contact telephone number.

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?