API ReferenceSuppliers

Update Supplier

Updates mutable fields on an existing supplier. Only fields included in the request body are modified.

Requires scope: suppliers:write

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Supplier ID.

Request

This endpoint expects an object.
businessNamestringOptional
Updated display name. Maximum 255 characters.
businessEmailstringOptional

Updated primary email. Maximum 255 characters. Pass null to clear.

contactNamestringOptional

Updated primary contact name. Maximum 255 characters. Pass null to clear.

phoneNumberstringOptional

Updated primary phone number. Maximum 50 characters. Pass null to clear.

addressstringOptional

Updated street address. Maximum 500 characters. Pass null to clear.

citystringOptional

Updated city. Maximum 255 characters. Pass null to clear.

statestringOptional

Updated state or province code. Maximum 50 characters. Pass null to clear.

zipCodestringOptional

Updated postal/ZIP code. Maximum 20 characters. Pass null to clear.

websitestringOptional

Updated website URL. Maximum 500 characters. Pass null to clear.

notestringOptional

Updated internal notes. Pass null to clear.

Response

This endpoint returns an object.
idUUID
Unique identifier for the supplier.
businessNamestring
Display name of the supplier business.
additionalContactslist of objects
Additional contacts at this supplier. Empty list if none configured.
businessEmailstring
Primary email address for the supplier business.
contactNamestring
Name of the primary contact person at this supplier.
phoneNumberstring
Primary phone number for the supplier.
addressstring
Street address.
citystring
City.
statestring

State or province code (e.g. TX).

zipCodestring

Postal/ZIP code.

websitestring
Supplier website URL.
notestring
Internal notes about this supplier.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error