Skip to content

E-mail distribution lists

The functionality is subject to module activation Mass e-mailing within the e-shop. The addon using this endpoint must therefore have this module defined as dependency.

Operations

Listing of e-mail distribution lists

Request

The e-mail distribution list named "newsletters" is the system one and is always available (if the e-shop has the module installed). This e-mail distribution list includes the e-mails of all customers who agreed to receiving e-mails.

Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/mailing-lists \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "mailingLists": [ … ]
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}