REST API - Unsubscribe recipient from an e-mail provider

Personal Library

https://support.intershop.com/kb/25359H

Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management 7.10 REST API.

URI	/subscriptions/<recipient's e-mail or "-" for authenticated user>
Http Method	DELETE
Short Description	Unsubscribes a recipient from e-mail marketing provider configured for the application
Query Parameters	none
Example Requests	/subscriptions/patricia@test.intershop.de /subscriptions/-
HTTP Status Codes	204 No Content 400 Bad Request Possible values for header ‘error-key’: subscriptions.subscription_not_found.error 404 Not found 500 Internal Server Error Possible values for header ‘error-key’: subscriptions.external_service.error
Description	This URI could be accessed with either authentication header or not. If such header, with valid credentials, is sent from the client and the sub resource is "-", e.g. /subscriptions/-, then the recipient e-mail will be taken from the user which credentials are sent. If valid e-mail addresses is used as sub resource name, e.g. /subscriptions/patricia@test.intershop.de, then this e-mail address will be unsubscribed subscription's provider. Whichever recipient's e-mail is used the response status codes will be 204 No Content, if the recipient is unsubscribed successfully, or 404 Not Found, if no such subscription exists. This resource depends on back office configuration for e-mail marketing provider. If no such provider is configured it'll respond with 404 Not Found.
Cartridge	app_sf_rest
Application	B2C Web Shop, SMB Web Shop

Product Version	7.4
Product To Version
Status	New Labels

JSON

Request Data Format	n.a.
Request related java object	n/a
Request Example	n/a
Response Data Format	n.a.
Response related java object	n/a
Response Example	n/a

XML

XML Request Data Format	n.a.
XML Request Java Objects	n/a
XML Request Example	n/a
XML Response Data Format	n.a.
XML Response Java Objects	n/a
XML Response Example	n/a

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.