Search
K
Newsletter

Newsletter

8OAS 3.0

Deprecated

As of 31.09.2026 this will be removed.

Manage newsletter subscriptions. See Wiki

API Base URL
  • Server 1:https://api-qual.migros.ch

    Public Kong Gateway URL

Security
Kong-Api-Key (apiKey)

Kong key-auth authentication

basicAuth (http)

Basic authentication is a simple authentication scheme built into the HTTP protocol.
To use it, send your HTTP requests with an Authorization header that contains the word Basic
followed by a space and a base64-encoded string username:password.

Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

Additional Information
Contact MGB-UDP-Products-Services (arg_mgb-udp-products-services@mgb.ch)

Newsletter

Returns a list of supported newsletter clients and its configuration.

DEPRECATED

Returns a list of supported newsletter clients and its configuration.

get
https://api-qual.migros.ch/migros/customers/subscriptions/v8/newsletter/clients

Query Parameters

langstring

Defines the language (de/fr/it/en) for this request as query parameter. Either use the query param “lang” or header “Accept-Language”, not both.

Allowed values:defriten

Default:de

Headers

Accept-Languagestring

Defines the language (de/fr/it/en) for this request as request header. Either use the query param “lang” or header “Accept-Language”, not both.

Allowed values:defriten

Default:de

Response

200 application/json

Returned when successful

NewsletterClientConfigurationCollection

A collection of NewsletterClientConfiguration instances.

clientsarray[object]required

A newsletter client configuration.

Show Child Parameters
get/migros/customers/subscriptions/v8/newsletter/clients
 
200 application/json

Returns the configuration for the given newsletter client.

DEPRECATED

Returns the configuration for the given newsletter client.

get
https://api-qual.migros.ch/migros/customers/subscriptions/v8/newsletter/clients/{client}

Query Parameters

langstring

Defines the language (de/fr/it/en) for this request as query parameter. Either use the query param “lang” or header “Accept-Language”, not both.

Allowed values:defriten

Default:de

Path Parameters

clientstringrequired

Name of the client.

Headers

Accept-Languagestring

Defines the language (de/fr/it/en) for this request as request header. Either use the query param “lang” or header “Accept-Language”, not both.

Allowed values:defriten

Default:de

Response

200 application/json

Returned when successful

NewsletterClientConfiguration

A newsletter client configuration.

fieldsarray[object]

A newsletter client field.

Show Child Parameters
namestringrequired
get/migros/customers/subscriptions/v8/newsletter/clients/{client}
 
200 application/json

Returns the newsletter profile for the given email address.

DEPRECATED

Returns the newsletter profile for the given email address.

get
https://api-qual.migros.ch/migros/customers/subscriptions/v8/newsletter/clients/{client}/profile

Query Parameters

emailstringrequired

The email address to search for.

langstring

Defines the language (de/fr/it/en) for this request as query parameter. Either use the query param “lang” or header “Accept-Language”, not both.

Allowed values:defriten

Default:de

Path Parameters

clientstringrequired

Name of the client. One of ‘migros_ch’, ‘migipedia’.

Headers

Accept-Languagestring

Defines the language (de/fr/it/en) for this request as request header. Either use the query param “lang” or header “Accept-Language”, not both.

Allowed values:defriten

Default:de

Response

200 application/json

Returned when successful

NewsletterProfile

Xcampaign newsletter profile.

emailstringrequired
fieldsobject

Profile fields (such as email address, first name, last name, etc).

* Additional properties are allowed.
idintegerrequired
statusstringrequired
get/migros/customers/subscriptions/v8/newsletter/clients/{client}/profile
 
200 application/json