Related Documents
Document Properties
Kbid25359H
Last Modified23-Jun-2020
Added to KB06-Nov-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Unsubscribe recipient from an e-mail provider


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

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

ApplicationB2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version


Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

Response related java object

n/a

Response Example

n/a

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets