Delete vendor

Permanently removes a vendor from the organization. This action cannot be undone. Supports both API key authentication (X-API-Key header) and session authentication (cookies + X-Organization-Id header).

DELETE /v1/vendors/{id}

Try it

Delete vendor

cURL

curl --request DELETE \
  --url http://localhost:3333/v1/vendors/{id} \
  --header 'X-API-Key: <api-key>'

200

{
  "message": "Vendor deleted successfully",
  "deletedVendor": {
    "id": "vnd_abc123def456",
    "name": "CloudTech Solutions Inc."
  },
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "[e-mail]"
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

id · string · required

Vendor ID

Example:

"vnd_abc123def456"

Response

200

application/json

Vendor deleted successfully

message · string

Example:

"Vendor deleted successfully"

deletedVendor · object

Show child attributes

deletedVendor. id · string

Deleted vendor ID

Example:

"vnd_abc123def456"

deletedVendor. name · string

Deleted vendor name

Example:

"CloudTech Solutions Inc."

authType · enum<string>

How the request was authenticated

Available options: api-key, session

authenticatedUser · object

User information (only for session auth)

Show child attributes

authenticatedUser. id · string

Example:

"usr_def456ghi789"

authenticatedUser. email · string

Example:

"[e-mail]"