Unsubscribing an account from a product – deployments with SSP

Request

To unsubscribe an account from a product (that is, to remove an entitlement from the account), the CRM should send a PUT request to:

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

where uid is the ID of the entitlement.

Headers

• x-correlation-id – identifier for logging, to correlate messages across a call flow

• Authorization – bearer token obtained in Getting an access token

• nv-tenant-id – the tenant ID

• Content-Type: application/json

Mandatory arguments

• uid – the ID of the entitlement to modify (in the URL path)

• status – the updated status of the entitlement. In this case, it must be UNSUBSCRIBED.

Optional arguments

This endpoint supports additional arguments, but for this use case, they are not used.

Example

A request with this payload unsubscribes the signed-in account from the product that entitlement specified in the URL relates to (that is, it unsubscribes the account from the product):

{
   "status": "UNSUBSCRIBED"
}

Response

A successful request returns an HTTP 200 status.

An invalid request returns an HTTP 400 status.

If the token is invalid, the request returns an HTTP 403 status.

If the tenant is invalid, the request returns an HTTP 404 status.

Example

{
  "matchedCount": 1,
  "modifiedCount": 1
}

See also

For full details of this API, see the CRM Gateway API documentation .