Subscribe a user to the mStudio newsletter

POST/newsletter-subscriptions/

API version

v2

Request method

POST

Operation ID

newsletter-subscribe-user

---

Request

Responses

Format

application/json

Description

Subscription information email has been sent.

Schema documentation

• activeboolean

  required
• emailstring

  required
• registeredboolean

  required

Example

{
  "active": true,
  "email": "a.lovelace@example.com",
  "registered": true
}

JSON Schema

{
  "properties": {
    "active": {
      "example": false,
      "type": "boolean"
    },
    "email": {
      "example": "a.lovelace@example.com",
      "type": "string"
    },
    "registered": {
      "example": true,
      "type": "boolean"
    }
  },
  "required": [
    "email",
    "active",
    "registered"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"firstName":"Ada","lastName":"Lovelace"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/newsletter-subscriptions

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.notification.newsletterSubscribeUser({
  "data": {
    "firstName": "Ada",
    "lastName": "Lovelace"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NewsletterSubscribeUser\NewsletterSubscribeUserRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NewsletterSubscribeUser\NewsletterSubscribeUserRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// NewsletterSubscribeUserRequestBody to learn how to construct a valid instance
$body = new NewsletterSubscribeUserRequestBody(/* TODO: ... */);

$request = (new NewsletterSubscribeUserRequest(
  body: $body
));
$response = $client->notification()->newsletterSubscribeUser($request);

var_dump($response->getBody();