Deactivate subscription
/km/api/v1/users/{id}/subscriptions/{subscriptionId}/deactivate
This method deactivates the subscription status of a specified subscription Id for a specified user.
Response Errors
The possible error responses for this method are as follows:
- OK-SEC0001
The error occurs when a user does not have the MODIFY_USER or MODIFY_WEB_USER privileges but attempts to modify the subscription of another user.
- OKDOM-USER0014
The error occurs in one of the following instances:
- A userId or subscriptionId specified with the request does not exist in the repository.
- The specified userId does not own a subscription.
Request
-
id: string
The user identifier
-
subscriptionId: string
The subscription identifier
Response
204 Response
Examples
The following example shows how to update the subscription status to deactivate for a specified subscription ID and a specified user ID by submitting a post request on the REST resource using cURL.
cURL Command
curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/users/{id}/subscriptions/{subscriptionId}/deactivate"
Example of Request Header
The following shows an example of the request header.
-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \ -H "Accept: application/json"
Example of Response Body
The following shows an example of the response body in JSON format.
This request does not return any response body.