Skip to main content
PATCH
Update a contact

Path Parameters

id
string
required

Contact ID

Example:

"1"

Query Parameters

orgId
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

companyId
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

Body

application/json
name
string | null

Display name. Pass null to clear.

Maximum string length: 255
chain
string | null

Chain identifier. Pass null to clear.

Maximum string length: 63
qboEntity
string | null

QuickBooks entity reference. Pass null to clear.

Maximum string length: 255
isEntity
boolean

Mark the contact as an Entity (vendor/person-level grouping). Requires a name; entity names are unique per company case-insensitively (409).

entityContactId
integer | null

Link this plain contact to an entity contact (must itself be an entity; an entity cannot link). Null clears.

Required range: x > 0
defaultAccount
string | null

Entity default GL account CODE prefilled on received invoices from this vendor. Null clears.

Maximum string length: 127
defaultVat
string | null

Entity default tax rate NAME (GET /taxes) prefilled on received invoices from this vendor. Null clears.

Maximum string length: 127

Response

Contact updated successfully

success
enum<boolean>
required
Available options:
true
data
object
required
Last modified on May 3, 2026