Delete a Client
Select
SaaS
Customer Managed
This operation deletes a client entity.
⚠️ Caution
This operation also deletes any backup data that is associated with the client.
Example
DELETE /Client/12
Path Parameters
- clientId integer required
The client ID of the client. If the client ID is not known, use the Get Client ID API to retrieve it
Query Parameters
- forceDelete boolean
Force Delete the client even if it is not retired
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object[]
errorCode integerentity object
srmReportSet integertype integerclientName stringsrmReportType integerclientSidePackage booleanclientId integer_type_ integerconsumeLicense boolean
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": [
{
"errorCode": 0,
"entity": {
"srmReportSet": 0,
"type": 0,
"clientName": "string",
"srmReportType": 0,
"clientSidePackage": true,
"clientId": 0,
"_type_": 0,
"consumeLicense": true
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": [
{
"errorCode": 0,
"entity": {
"srmReportSet": 0,
"type": 0,
"clientName": "V11",
"srmReportType": 0,
"clientSidePackage": true,
"clientId": 12,
"_type_": 3,
"consumeLicense": true
}
}
]
}
Loading...