Delete Business

DELETE 
/api/v2/admin/business/:businessId

Delete a business.

⚠️Warning:⚠️ all instances must be deleted or disconnected before deletion, or an exception will be raised.

Request

Path Parameters

businessId stringrequired

Business ID.

Query Parameters

force Force

Force the action to be performed.

Responses

200

BusinessCreateResponse

application/json

Schema

Schema

businessId stringrequired
name stringrequired
businessToken stringrequired
attributes objectrequired
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired

Example (from schema)

{
  "businessId": "string",
  "name": "string",
  "businessToken": "string",
  "attributes": {},
  "createdAt": "2024-04-14T14:11:05.598Z",
  "updatedAt": "2024-04-14T14:11:05.598Z",
  "deletedAt": "2024-04-14T14:11:05.598Z"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...