Skip to main content
PATCH
Edit a supplier
Requires permission: supplier:update
The request edits the supplier named in the URL; a uuid in the body is ignored. You can edit a supplier your account created until that supplier claims its own Variable account. After that, or for a supplier another account created, the request returns a 403 and saves nothing.

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string
required

Supplier UUID. GET and PATCH also accept the supplier's syncId or internalId; DELETE requires the UUID.

Body

application/json
uuid
string<uuid>
syncId
string

An identifier to use when syncing data with other systems. Read more

Example:

"sync123"

name
string
Example:

"Supplier Name"

Response

A supplier

uuid
string<uuid>
syncId
string

An identifier to use when syncing data with other systems. Read more

Example:

"sync123"

name
string
Example:

"Supplier Name"

connected
boolean
Example:

true

image
string
Example:

"https://app.variable.global/uploads/image.jpg"