DELETE /api/businesses/{BusinessID}

Deletes a business on the platform.

Supported Versions: 8.3 and later

Authorization Roles/Permissions: Must be an authorized administrator: Business Admin, Site Admin, or other authorized Admin.

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

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

Back to top

Sample Request

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

Request URL

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

Sample request headers

Accept: text/plain
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

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 (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

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

Back to top

Response

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

Back to top

Sample Response

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

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

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

Back to top

Error Codes/Messages

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.
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. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics