Newsletter — Zanfia help center

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

5 min czytaniaOstatnia aktualizacja: 10 wrz 2026

Zawartość produktów typu Newsletter, adresowana przez id produktu: lista zarchiwizowanych wydań (widok twórcy, razem z ukrytymi), widoczność, tryb wyświetlania i okładka pojedynczych wydań, ustawienia newslettera oraz pisanie wydań. Wydania zwykle powstają przez wysyłkę e-maili; API pozwala też napisać post bez wysyłki: POST …/issues tworzy ukryte wydanie w trybie artykułu, PUT …/issues/{issueId}/draft trzyma szkic w Markdownie, POST …/draft/publish go publikuje. Szkice nie dotykają opublikowanych pól aż do publikacji. 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`

curl -X GET "https://example.com/products/string/newsletter/issues"

{  "items": [    {      "id": "string",      "emailId": "string",      "subject": "string",      "slug": "string",      "status": "public",      "landingPageVisibility": "public",      "renderMode": "snapshot",      "source": "email-loop",      "thumbnailUrl": "string",      "hasUnpublishedDraft": true,      "createdAt": "string"    }  ],  "nextCursor": "string",  "hasMore": true}

{  "error": "string",  "message": "string"}

Utwórz wydanie bez wysyłki

POST/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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

"Write a post without sending": creates a HIDDEN, article-first issue with empty content. Fill it in via the draft routes, then publish the draft.

subject*string

Initial subject / title (non-empty).

Response Body

`application/json`

curl -X POST "https://example.com/products/string/newsletter/issues" \  -H "Content-Type: application/json" \  -d '{    "subject": "string"  }'

{  "issue": {    "id": "string",    "emailId": "string",    "subject": "string",    "slug": "string",    "status": "public",    "landingPageVisibility": "public",    "renderMode": "snapshot",    "source": "email-loop",    "thumbnailUrl": "string",    "hasUnpublishedDraft": true,    "createdAt": "string"  }}

{  "error": "string",  "message": "string"}

Skopiuj wydania do innych newsletterów

POST/products/{productId}/newsletter/issues/copy

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.

issueIds*array<string>

Archived issue ids of THIS product's newsletter to copy (non-empty).

targetProductIds*array<string>

Newsletter products to copy into (non-empty); other product types are skipped, not failed.

Response Body

`application/json`

curl -X POST "https://example.com/products/string/newsletter/issues/copy" \  -H "Content-Type: application/json" \  -d '{    "issueIds": [      "string"    ],    "targetProductIds": [      "string"    ]  }'

{  "copied": [    {      "productId": "string",      "newsletterId": "string",      "issueIds": [        "string"      ]    }  ],  "skipped": [    {      "productId": "string",      "reason": "product-not-found"    }  ]}

{  "error": "string",  "message": "string"}

Zmień widoczność i okładkę 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.

status?ArchivedEmailStatus

Private archive visibility (creator's members area).

Value in

"public"
"hidden"

landingPageVisibility?ArchivedEmailVisibility

Public landing-page visibility.

Value in

"public"
"hidden"
"locked"

renderMode?ArchivedEmailRenderMode

Which representation read surfaces render (sent-email snapshot vs. markdown article).

Value in

"snapshot"
"article"

thumbnailUrl?|

Cover image URL (https); null clears the cover.

Response Body

`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",  "message": "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`

curl -X DELETE "https://example.com/products/string/newsletter/issues/string"

{  "issueId": "string",  "deleted": true}

{  "error": "string",  "message": "string"}

Zapisz szkic wydania

PUT/products/{productId}/newsletter/issues/{issueId}/draft

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.

Unpublished draft fields of an issue. Presence-based: only the keys sent are written — a subject-only save never wipes a pending content draft; an explicit null clears that one draft field. At least one key required.

subject?string|null

articleContent?|

Article body as Markdown.

Response Body

`application/json`

curl -X PUT "https://example.com/products/string/newsletter/issues/string/draft" \  -H "Content-Type: application/json" \  -d '{}'

{  "issueId": "string",  "draft": {    "subject": "string",    "articleContent": "string"  }}

{  "error": "string",  "message": "string"}

Odrzuć szkic wydania

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

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`

curl -X DELETE "https://example.com/products/string/newsletter/issues/string/draft"

{  "issueId": "string",  "discarded": true}

{  "error": "string",  "message": "string"}

Opublikuj szkic wydania

POST/products/{productId}/newsletter/issues/{issueId}/draft/publish

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.

makePublic?boolean

Also flip status to public (members-area visibility) in the same write.

Response Body

`application/json`

curl -X POST "https://example.com/products/string/newsletter/issues/string/draft/publish" \  -H "Content-Type: application/json" \  -d '{}'

{  "issueId": "string",  "promotion": {    "subject": "string",    "articleContent": "string",    "renderMode": "snapshot",    "slug": "string",    "status": "public"  }}

{  "error": "string",  "message": "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.

archive?

archiveInbox?

doubleOptIn?string

Whether subscribers must confirm their email before getting access

Value in

"none"
"external"

clientTags?array<string>

Tags applied to new subscribers.

Response Body

`application/json`

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

{  "updated": true}

{  "error": "string",  "message": "string"}

Czy ten artykuł był pomocny?

Powiązane artykuły

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

Lista wydań newslettera

200application/json

4XXapplication/json

Utwórz wydanie bez wysyłki

200application/json

4XXapplication/json

Skopiuj wydania do innych newsletterów

200application/json

4XXapplication/json

Zmień widoczność i okładkę wydania

200application/json

4XXapplication/json

Usuń wydanie

200application/json

4XXapplication/json

Zapisz szkic wydania

200application/json

4XXapplication/json

Odrzuć szkic wydania

200application/json

4XXapplication/json

Opublikuj szkic wydania

200application/json

4XXapplication/json

Aktualizuj ustawienia newslettera

200application/json

4XXapplication/json

Powiązane artykuły

Przegląd API

Uwierzytelnianie i klucze API

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`