Deleting a third-party product entitlement

Overview

If the CRM system needs to delete a third-party product entitlement, it should call the CRM Gateway (CRM-GW) endpoint described below and not the Rights Manager (RMG) entitlement deletion endpoint.

This ensures that Bango is notified of the change so that it can remove the subscription.

Though it is possible to delete an entitlement (as described here), you are recommended to cancel the entitlement instead – see Cancelling a third-party product entitlement.

Cancelled entitlements still exist in OPF, so, for example, you can find out when an entitlement was cancelled.

A deleted entitlement is removed completely and can no longer be tracked.

Request

To delete a third-party product entitlement, the CRM system should send a DELETE request to:

BASH

https://<host>:<port>/crm-gateway/v2/rmg/v1/entitlements/{entitlementId}

Headers

x-correlation-id – identifier for logging, to correlate messages across a call flow
Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)
Content-Type: application/json

Mandatory arguments

entitlementId – the ID of the entitlement to be deleted

Optional arguments

None

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A forbidden request (invalid token) returns an HTTP 403 status.

If the specified tenant does not exist, the request returns an HTTP 404 status.

See the (25.12_Q1) CRM Gateway API documentation for the specific error codes and their meanings.

Example

A successful request returns the following response:

JSON

{
  "deletedCount": 1
}