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. Omitted or null leaves the current value unchanged.

contactNamestringOptional

Updated primary contact name. Maximum 255 characters. Omitted or null leaves the current value unchanged.

phoneNumberstringOptional

Updated primary phone number. Maximum 50 characters. Omitted or null leaves the current value unchanged.

addressstringOptional

Updated street address. Maximum 500 characters. Omitted or null leaves the current value unchanged.

citystringOptional

Updated city. Maximum 255 characters. Omitted or null leaves the current value unchanged.

statestringOptional

Updated state or province code. Maximum 50 characters. Omitted or null leaves the current value unchanged.

zipCodestringOptional

Updated postal/ZIP code. Maximum 20 characters. Omitted or null leaves the current value unchanged.

websitestringOptional

Updated website URL. Maximum 500 characters. Omitted or null leaves the current value unchanged.

notestringOptional

Updated internal notes. Omitted or null leaves the current value unchanged.

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.
businessEmailstringOptional
Primary email address for the supplier business.
contactNamestringOptional
Name of the primary contact person at this supplier.
phoneNumberstringOptional
Primary phone number for the supplier.
addressstringOptional
Street address.
citystringOptional
City.
statestringOptional

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

zipCodestringOptional

Postal/ZIP code.

websitestringOptional
Supplier website URL.
notestringOptional
Internal notes about this supplier.
createdAtdatetimeOptional
ISO 8601 timestamp when the record was created.
updatedAtdatetimeOptional
ISO 8601 timestamp when the record was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error