Skip to main content
PATCH
Update matching vendors

Authorizations

X-API-Key
string
header
required

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

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json
isArchived
boolean
name
string
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.

values
object[]