Delete sandbox organisation

DELETE 
/v2/config/sandbox-org/:sandboxOrgId

Deletes one sandbox organisation of the organisation. Give the sandbox organisation ID in the path. The service removes the wallet of the sandbox organisation and all the data in it.

You cannot delete the main wallet. If the given ID is the main wallet, the service gives HTTP 400.

After the deletion, an API key that is bound to this sandbox organisation no longer works. To work in a sandbox organisation through the API, select the sandbox organisation in the dashboard, then create the API key under Account > Developer APIs (Create API Key). The key is bound to the sandbox organisation, and every call with it runs there.

Request

Path Parameters

sandboxOrgId stringrequired

Unique identifier of the sandbox organisation.

Responses

204

The service deleted the sandbox organisation. The response has no body.

Response Headers

400

The given ID is the main wallet, and the service cannot delete it.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation has no sandbox organisation with this ID.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...