Skip to main content
PUT
Update vendor profile

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Path Parameters

vendorId
string
required

Vendor ObjectId

Body

application/json
companyName
string
Example:

"Acme Corporation"

phone
string
Example:

"+1-555-123-4567"

email
string<email>
Example:

"vendor@acme.com"

website
string<uri>
Example:

"https://acme.com"

taxId
string
Example:

"12-3456789"

vatNumber
string
Example:

"GB123456789"

about
string
Example:

"Leading widget manufacturer"

Example:

"https://cdn.example.com/logo.png"

Response

Vendor profile updated successfully

success
enum<boolean>
Available options:
true
data
object