Skip to main content
PATCH
Update matching contacts

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
email
string | null
phone
string | null
title
string | null
companyName
string | null
vendorId
string<uuid> | null
role
string | null
isPrimary
boolean
notes
string | null
metadata
object

Response

Successful response.

values
object[]