Skip to main content

Getting the subscription status of the subscription

GET/v2/newsletter-subscriptions/self
API version
v2
Request method
GET
Operation ID
newsletter-get-info

Request​

No request parameters.

Responses​

Format
application/json
Description

Status information about the subscription.

  • activeboolean
    required
  • emailstring
    required
  • registeredboolean
    required
Content-Type: application/json

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

Usage examples​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/newsletter-subscriptions/self
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.newsletterGetInfo({});

assertStatus(response, 200);
  
use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NewsletterGetInfo\NewsletterGetInfoRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new NewsletterGetInfoRequest());
$response = $client->notification()->newsletterGetInfo($request);

var_dump($response->getBody();

On this page