Delete a Callback

Use this endpoint to delete an existing callback. A callback can only be deleted if there are no active subscriptions.

A successful response returns a 200 response code and a response body indicating the callback was deleted.

Service URL:

/rest/api/v1.3/notifications/callbacks/{callbackName}

Path Parameters:

callbackName – Name of the callback to delete.

Request Method:

DELETE

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body - Required Properties:

Not applicable

Sample Request Body

Not applicable

Sample Response Body - Success

{
  "message": "CallBack [<callback_name> ] deleted successfully",
  "status": true
}

Sample Response Body - Failure

404 Not Found

Callback not found: Requests fail if the callback name specified is not found. The error resembles:

{
  "type": "",
  "title": "Object not found",
  "errorCode": "OBJECT_NOT_FOUND",
  "detail": "CallBack [<callback_name>] not found",
  "errorDetails": []
}

400 Bad Request

Subscriptions exist for the callback: Requests fail if subscriptions exist for the callback. Delete all subscriptions for the callback before deleting the callback. The error resembles:

{
  "type":"",
  "title":"Invalid request parameters",
  "errorCode":"INVALID_PARAMETER",
  "detail":"Subscription with same name already exists",
  "errorDetails":[]
}