Skip to main content
PUT
Upsert a vendor

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Path Parameters

id
string<uuid>
required

Record id.

Query Parameters

update
string[]
required

Columns to overwrite when the row already exists. Repeat the parameter for each column: a single comma-separated value is read as one column name and fails at the database. Without the parameter the request is rejected with 400.

Body

application/json
name
string
required
id
string<uuid>

Optional client-supplied ID.

isArchived
boolean
identifier
string
code
string | null
type
enum<string>
Available options:
supplier,
manufacturer,
subcontractor
status
enum<string>
Available options:
active,
inactive
website
string | null
addressLine1
string | null
addressLine2
string | null
city
string | null
stateOrProvince
string | null
postalCode
string | null
country
enum<string> | null
Available options:
US,
CA
defaultLeadTimeDays
integer | null
metadata
object

Response

Successful response.

value
object