Resuming a third-party product entitlement – SSP deployment

Request

To resume a suspended third-party product entitlement, the CRM system should send a PUT request to:

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 (in URL) – the ID of the entitlement to be resumed

• status (in body) – in this case, it must be ACTIVE.

Optional arguments

None for third-party product entitlements

Example

A PUT request with the following body will resume the suspended entitlement whose ID is specified in the URL:

{
  "status": "ACTIVE"
}

Response

A successful request returns an HTTP 200 status.

If the request is awaiting confirmation from the third-party provider, the request returns an HTTP 202 status. When OPF receives this confirmation, it notifies your CRM system – see Handling third-party product entitlement changes.

A bad request returns an HTTP 400 status.

A forbidden request returns an HTTP 403 status.

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

See the CRM Gateway API documentation v1 for the specific error codes and their meanings.

Example

A successful request returns the following response body:

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

See also

CRM Gateway API documentation v1