DELETE /api/businesses/{BusinessID}

Deletes a business on the platform.

Authorization Roles/Permissions: Must be logged in. Must have Delete permission for the resource. Business Admin or other authorized Admin.

This topic includes the following sections:

HTTP Method

DELETE

https://{hostname}/api/businesses/{BusinessID}

The example below shows a request to delete the specified business.

Sample Request URL

https://{hostname}/api/businesses/3daa602e-1484-49d6-a95b-d11b67d0705e.acmepaymentscorp

Sample request headers

Accept: text/plain
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type	Any format (/)
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Parameter	Parm Type	Data Type	Required	Description
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.

If successful, this operation returns HTTP status code 200, with the BusinessID of the business that was deleted.

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Date: Tue, 30 Aug 2016 18:37:51 GMT

Sample response body

3daa602e-1484-49d6-a95b-d11b67d0705e.acmepaymentscorp

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	text/plain

Name	Type	Description
BusinessID	string	The unique ID for a specific business organization on the platform.

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found. For example, you might get this if you are trying to delete a resource that was already deleted.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.