Remove an Account from a Hierarchy
delete
/bcws/webresources/v1.0/accounts/hierarchy/remove/{id}
Removes the specified account from an organization hierarchy.
Request
Path Parameters
-
id(required): string
The ID of the account to remove.
Query Parameters
-
childrenParentId: string
The account ID of the parent account of the account being deleted, to be the new parent of child accounts.
-
removeChildren: boolean
Whether the child accounts should also be removed (true) or not (false).
Supported Media Types
- application/xml
- application/json
Response
200 Response
The account was successfully removed from the organization hierarchy.
500 Response
An internal server error occurred.
Examples
This example shows how to remove an account from an organization hierarchy by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X DELETE 'http://hostname:port/bcws/webresources/v1.0/accounts/hierarchy/remove/0.0.0.1+-account+149726'
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
Example of Response Body
If successful, the response code 200 is returned with no response body.