Edit

Share via


Delete subscriptions

Deletes a subscriptions object for Business Central.

Custom APIs

If you're subscribing to a custom API page, both the URL you send the subscription HTTP request to and the resource path you wish to subscribe to must include the <APIPublisher>, <APIGroup>, and <APIVersion> elements equivalent to: api/<APIPublisher>/<APIGroup>/<APIVersion>/subscriptions. For example, if your API publisher is pub, your API group is grp, and the version is 1.0, part of the URL will contain these elements api/pub/grp/v1.0/subscriptions.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

Important

The subscription ID must be enclosed in single quotes in the URL.

DELETE businesscentralPrefix/subscriptions('{id}')

Request headers

Header Value
Authorization Bearer {token}. Required.
If-Match Required. When this request header is included and the eTag provided doesn't match the current tag on the subscription, the subscription won't be updated.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 204 No Content response code.

Example

Request

Here's an example of the request. Note that the subscription ID value must be enclosed in single quotes.

DELETE https://{businesscentralPrefix}/api/v1.0/subscriptions('c670ea73-b37b-4a7e-8dc4-de3e1f6f5445')

Response

No response body.

Tips for working with the APIs
Subscriptions
Get subscriptions
Create subscriptions
Update subscriptions