Suspending a third-party product entitlement – non-SSP deployment

Request

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

https://<host>:<port>/tpes/v1/operator/entitlements/{entitlementId}/actions/suspend

Headers

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

• Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)

• nv-tenant-id – the tenant ID

Mandatory arguments

• entitlementId (in URL) – the ID of the entitlement to be suspended

Optional arguments

None

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 entitlement does not exist, the request returns an HTTP 404 status.

See the Third Party Entitlement Service (TPES) API documentation for the specific error codes and their meanings.

See also

Third Party Entitlement Service (TPES) API documentation