Skip to main content
DELETE
Delete company
Soft delete — the record is retained with deletedAt, its name is freed (unique case-insensitively), and its addresses are not removed. See Deleting and archiving.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Path Parameters

id
string
required

"id" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

id
string

Response

Responses for DELETE /api/rest/companies/{id}

deleteCompany
Companies · object | null

Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.