Skip to main content
PUT
Update vendor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

The UUID of the business the vendor belongs to

vendorId
string<uuid>
required

The UUID of the vendor to update

Body

application/json
external_id
string | null

External ID for the vendor

individual_name
string | null

Name of individual vendor or contact

company_name
string | null

Name of company vendor

email
string | null

Email address

mobile_phone
string | null

Mobile phone number

office_phone
string | null

Office phone number

address_string
string | null

Physical address

memo
string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

tags
object[]

Response

200 - application/json

Vendor updated successfully

id
string<uuid>

Unique identifier for the vendor.

external_id
string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

individual_name
string | null

Full name of the individual vendor or contact at a corporate vendor.

company_name
string | null

Name of the company vendor.

email
string | null

Email address of the vendor.

mobile_phone
string | null

Mobile phone number of the vendor.

office_phone
string | null

Office phone number of the vendor.

address_string
string | null

Address of the vendor.

memo
string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

status
enum<string>

Status of the vendor.

Available options:
ACTIVE,
ARCHIVED
transaction_tags
object[]