Skip to main content
DELETE
/
platform
/
admin
/
tenant
cURL
curl --request DELETE \
  --url https://api.example.com/platform/admin/tenant
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Query Parameters

id
integer<int64>
api-version
string | null

Response

Wrapper for API operation results containing success status, error information, and return value.

isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
value
object

The result value returned when the operation is successful.

Example:
{ "success": true }