Hold a subscription product
post
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/action/putOnHold
This method lets you put a subscription product on hold till you remove the hold.
Request
Path Parameters
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
SubscriptionProductPuid(required): string
The subscription product PUID.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
object
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Examples
The following example shows how to remove hold on a subscription product by submitting a POST request on the REST resource using cURL.
cURL Command
curl --user
sales_cloud_user -X POST -d @example_request_payload.json
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/products/GP-5678-PRDT-7/action/removeHold
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "result": "Success" }