Related Documents
Document Properties
Kbid25360S
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 - Subscribe a recipient to an e-mail marketing provider


Note

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

URI

/subscriptions

Http Method

POST

Short Description

Subscribes a recipient, with an e-mail, to the e-mail marketing provider configured for the application

Query Parameters

none

Example Requests

/subscriptions

HTTP Status Codes

201 Created

404 Not Found

       Possible values for header error-key:

    • subscriptions.provider_not_found.error

400 Bad Request

       Possible values for header error-key:

    • subscriptions.recipient.invalid.error
    • subscriptions.recipient.missing.error

409 Conflict

       Possible values for header error-key:

    • subscriptions.recipient.already_subscribed.error

500 Internal Server Error

       Possible values for header error-key:

    • subscriptions.external_service.error

Description

A subscriber, represented with an e-mail in the request body, is subscribed to the e-mail marketing provider specified for the application.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version


Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource
com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO

Request Example

Subscribe with an e-mail:

{
    "recipient" : "d.weiers@test.intershop.de"
}

Subscribe as authenticated user:

{
    "recipient" : "-"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

{
    "type": "Link",
    "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/subscriptions/-",
    "title": "Subscription successful"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource
com.intershop.sellside.rest.common.capi.resourceobject.subscription.SubscriptionRO

XML Request Example

Subscribe with e-mail:

<Subscription>
   <recipient>d.weiers@test.intershop.de</recipient>
</Subscription>

Subscribe as authenticated user:

<Subscription>
   <recipient>-</recipient>
</Subscription>

XML Response Data Format

text/xml

XML Response Java Objects

201 Created
com.intershop.sellside.rest.common.capi.resource.subscription.SubscriptionsResource
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
  <title>Subscription successful</title>
  <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/subscriptions/d.weiers%40test.intershop.de</uri>
</Link>

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
Tickets