Basic information

GET /{shopId}/newsletter-campaigns

Returns all newsletter campaigns of a shop.

Authorisation

OAuth 2.0 Token required with scopes:

newsletters_read

URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop

Query parameters

Name Type Description
page integer

Represents the current page.

Required: false
Default: 1
Minimum: 1
resultsPerPage integer

Specifies the maximum number of results per page.

Required: false
Default: 10
Maximum: 100

Response attributes

Name Type Description
results

integer

The number of newsletter campaigns in total.

page

integer

The page number on which the campaigns appear.

resultsPerPage

integer

The number of campaigns returned per page.

items

array of newsletterCampaign

The list of all newsletter campaigns of a shop.

Response

HTTP 200

Media type application/json

{
  "results": 2,
  "page": 1,
  "resultsPerPage": 10,
  "items": [
    {
      "campaignId": "570BACBD-7FB3-E667-835B-AC15320732BE",
      "language": "en",
      "identifier": "NewTrends_EN",
      "name": "New trends at Schneiderei",
      "description": "Learn more about new trends at schneiderei.com",
      "numberOfSubscribers": 0,
      "subject": "New shop trends"
    },
    {
      "campaignId": "570BACBE-9333-CAB0-40BC-AC153207322B",
      "language": "de",
      "identifier": "NewTrends_DE",
      "name": "Neue Trends in der Schneiderei",
      "description": "Lesen Sie ├╝ber die neuen Trends bei schneiderei.de",
      "numberOfSubscribers": 0,
      "subject": "Neue Shop-Trends"
    }
  ]
}