Push Device Subscription (DELETE)
Unsubscribes the speficied device from a tag.
Description
Given the deviceId and the tag name, the request deletes a existing subscription from a tag specified. It will return HTTP response code 204 with no content on successfully unsubscribing
Method
DELETE
Path
/apps/applicationId/subscriptions
Example
https://example.com:443/myproject/imfpush/v1/apps/myapp/subscriptions?deviceId=12345-6789&tagName=testTag
Path Parameters
- applicationId
- The name or identifier of the application
Query Parameters
Query parameters are optional.
- deviceId
- The unique identifier for the device
- tagName
- The tag name to unsubscribe
Header Parameters
Some header parameters are optional.
- Accept-Language
- (Optional) The preferred language to use for error messages. Default:en-US
- Authorization
- The token with the scope "unsubscribe-tag" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.
- mfpEnvironmentName
- (Optional) The environment name to use while executing the request.
- mfpEnvironmentVersion
- (Optional) The application version to use while executing the request.
Produces
application/json
Errors
400A device registraion has userId longer than 254 characters.
401
Unauthorized - The caller is either not authenticated or not authorized to make this request.
404
A device registraion with the specified deviceId is not found.
405
Unsupported Content type - The content type specified in Content-Type header is not application/json.
406
Unsupported Accept type - The content type specified in Accept header is not application/json.
500
An internal error occurred.