Skip to main content
PATCH
/
vendors
/
{id}
Update vendor
curl --request PATCH \
  --url https://api.antei.com/vendors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "country": "<string>",
  "tax_id": "<string>",
  "exempt": true,
  "email": "jsmith@example.com"
}'
{
  "id": "<string>",
  "name": "<string>",
  "country": "<string>",
  "tax_id": "<string>",
  "exempt": true,
  "email": "jsmith@example.com"
}
This endpoint lets you update a vendor’s details. Only the fields you provide will be modified. You must specify the vendor ID in the URL path.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the vendor to update

Body

application/json
​
name
string
required
​
country
string
required
​
tax_id
string
​
exempt
boolean
​
email
string<email>

Response

200 - application/json

Updated vendor

​
id
string
required

Unique identifier for the vendor

​
name
string
required

Vendor's legal or trading name

​
country
string
required

Country of vendor operation

​
tax_id
string

Vendor's tax identification number

​
exempt
boolean

Indicates whether the vendor is tax exempt

​
email
string<email>

Vendor's contact email