Skip to navigation

Update Vendor

View as Markdown

Updates vendor profile fields. payment_term_id changes the vendor’s default payment term and clear_payment_term removes it.

Requires the can_modify_vendor_profile permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

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

identitystring
The identity for the active workspace.

Path parameters

idstringRequired

Request

This endpoint expects an object.
display_namestringOptional
first_namestringOptional
last_namestringOptional
company_namestringOptional
emailstringOptionalformat: "email"
phonestringOptional
currency_codestringOptional
payment_term_idstringOptionalformat: "uuid"
Default payment term for this vendor. Applied to new bills that name no term or due date.
clear_payment_termbooleanOptional
Send true to remove the vendor's default payment term.
shipping_addressobjectOptional
billing_addressobjectOptional

Response

OK
dataobject
statusboolean
messagestring

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error