POST
/
v1
/
businesses
/
{businessId}
/
vendors
/
{vendorId}
/
archive
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendors/{vendorId}/archive \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "individual_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "mobile_phone": "<string>",
  "office_phone": "<string>",
  "address_string": "<string>",
  "notes": "<string>",
  "status": "ACTIVE"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
businessId
string
required

The UUID of the business the vendor belongs to

​
vendorId
string
required

The UUID of the vendor to archive

Response

200 - application/json
Vendor archived successfully
​
id
string

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.

​
notes
string | null

Notes about the vendor.

​
status
enum<string>

Status of the vendor.

Available options:
ACTIVE,
ARCHIVED
Update vendorUnarchive vendor