Workspace API

Newsletter

Endpointy „Newsletter” Zanfia Workspace API — ze schematami i przykładami kodu.

2 min czytaniaOstatnia aktualizacja: 26 lip 2026

Zawartość produktów typu Newsletter, adresowana przez id produktu: lista zarchiwizowanych wydań (widok twórcy, razem z ukrytymi), widoczność pojedynczych wydań i ustawienia newslettera. Wydania powstają przez wysyłkę e-maili - API zarządza archiwum, nie tworzy wydań. Wszystkie endpointy wymagają nagłówka Authorization: Bearer — zobacz Uwierzytelnianie.

Lista wydań newslettera

GET/products/{productId}/newsletter/issues

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

Query Parameters

cursor?string

Opaque cursor from a previous page.

limit?integer

Page size 1-50 (default 20).

Response Body

application/json

application/json

curl -X GET "https://example.com/products/string/newsletter/issues"
{  "items": [    {      "id": "string",      "emailId": "string",      "subject": "string",      "slug": "string",      "status": "public",      "landingPageVisibility": "public",      "createdAt": "string"    }  ],  "nextCursor": "string",  "hasMore": true}
{  "error": "string"}

Zmień widoczność wydania

PATCH/products/{productId}/newsletter/issues/{issueId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

issueId*string

Newsletter issue id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "https://example.com/products/string/newsletter/issues/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "issueId": "string",  "updated": true}
{  "error": "string"}

Usuń wydanie

DELETE/products/{productId}/newsletter/issues/{issueId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

issueId*string

Newsletter issue id

Response Body

application/json

application/json

curl -X DELETE "https://example.com/products/string/newsletter/issues/string"
{  "issueId": "string",  "deleted": true}
{  "error": "string"}

Aktualizuj ustawienia newslettera

PATCH/products/{productId}/newsletter/settings

Authorization

bearerAuth
AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

productId*string

Product id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial settings patch. archive merges per-field over the current config; the other blocks replace whole. At least one block is required.

Response Body

application/json

application/json

curl -X PATCH "https://example.com/products/string/newsletter/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "updated": true}
{  "error": "string"}

Czy ten artykuł był pomocny?

Powiązane artykuły

Coś się nie zgadza? Napisz do nas na support@zanfia.com.