REST API - Unsubscribe recipient from an e-mail provider

/subscriptions/<recipient's e-mail or "-" for authenticated user>

Unsubscribes a recipient from e-mail marketing provider configured for the application

none

/subscriptions/patricia@test.intershop.de

/subscriptions/-

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

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.

app_sf_rest