Workspace API

Formularze zapisu

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

3 min czytaniaOstatnia aktualizacja: 26 lip 2026

Samodzielne formularze zapisu (audience-subscription) i ich zgłoszenia. config przy PATCH zastępowany jest w całości — wysyłaj kompletny obiekt. Formularze powiązane z produktem zarządzane są przez produkt i nie dadzą się tu usunąć (409 product-bound). Wszystkie endpointy wymagają nagłówka Authorization: Bearer — zobacz Uwierzytelnianie.

Lista formularzy zapisu

GET/forms

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/forms"
{  "forms": [    {      "id": "string",      "name": "string",      "submitAction": "audienceSubscription",      "tagIds": [        "string"      ],      "submissionsCount": 0,      "optInMode": "double",      "redirectUrl": "string",      "confirmationEmail": {        "subject": "string",        "intro": "string"      },      "migratedFromProductId": "string",      "createdAt": "string",      "updatedAt": "string"    }  ]}
{  "error": "string"}

Utwórz formularz zapisu

POST/forms

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Creates a standalone AudienceSubscription form (product-bound forms are created via the product editor).

Response Body

application/json

application/json

curl -X POST "https://example.com/forms" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "formId": "string"}
{  "error": "string"}

Pobierz formularz zapisu

GET/forms/{formId}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

formId*string

Form id

Response Body

application/json

application/json

curl -X GET "https://example.com/forms/string"
{  "id": "string",  "name": "string",  "submitAction": "audienceSubscription",  "tagIds": [    "string"  ],  "submissionsCount": 0,  "optInMode": "double",  "redirectUrl": "string",  "confirmationEmail": {    "subject": "string",    "intro": "string"  },  "migratedFromProductId": "string",  "createdAt": "string",  "updatedAt": "string",  "config": {    "variant": "basic",    "scheme": "auto",    "buttonText": "string",    "emailPlaceholder": "string",    "headerText": "string",    "successMessage": "string",    "descriptionText": "string",    "color": "string",    "background": "string",    "claim": "string",    "privacyPolicyUrl": "string",    "showClaim": true,    "showHeader": true,    "showDescription": true,    "showPrivacyPolicyInfo": true,    "showFirstNameInput": true,    "firstNameRequired": true,    "showPhoneNumberInput": true,    "phoneNumberRequired": true,    "customDomain": "string",    "termsAndPrivacyPolicyConsentRequired": true,    "showTermsUrl": true,    "termsUrl": "string"  },  "localizedConfig": {    "property1": {      "variant": "basic",      "scheme": "auto",      "buttonText": "string",      "emailPlaceholder": "string",      "headerText": "string",      "successMessage": "string",      "descriptionText": "string",      "color": "string",      "background": "string",      "claim": "string",      "privacyPolicyUrl": "string",      "showClaim": true,      "showHeader": true,      "showDescription": true,      "showPrivacyPolicyInfo": true,      "showFirstNameInput": true,      "firstNameRequired": true,      "showPhoneNumberInput": true,      "phoneNumberRequired": true,      "customDomain": "string",      "termsAndPrivacyPolicyConsentRequired": true,      "showTermsUrl": true,      "termsUrl": "string"    },    "property2": {      "variant": "basic",      "scheme": "auto",      "buttonText": "string",      "emailPlaceholder": "string",      "headerText": "string",      "successMessage": "string",      "descriptionText": "string",      "color": "string",      "background": "string",      "claim": "string",      "privacyPolicyUrl": "string",      "showClaim": true,      "showHeader": true,      "showDescription": true,      "showPrivacyPolicyInfo": true,      "showFirstNameInput": true,      "firstNameRequired": true,      "showPhoneNumberInput": true,      "phoneNumberRequired": true,      "customDomain": "string",      "termsAndPrivacyPolicyConsentRequired": true,      "showTermsUrl": true,      "termsUrl": "string"    }  }}
{  "error": "string"}

Edytuj formularz zapisu

PATCH/forms/{formId}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

formId*string

Form 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/forms/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "ok"}
{  "error": "string"}

Usuń formularz zapisu

DELETE/forms/{formId}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

formId*string

Form id

Response Body

application/json

application/json

curl -X DELETE "https://example.com/forms/string"
{  "status": "ok"}
{  "error": "string"}

Lista zgłoszeń z formularza

GET/forms/{formId}/submissions

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

formId*string

Form id

Query Parameters

limit?integer
Rangevalue <= 1000

Response Body

application/json

application/json

curl -X GET "https://example.com/forms/string/submissions"
{  "submissions": [    {      "id": "string",      "email": "string",      "firstName": "string",      "clientId": "string",      "tagIds": [        "string"      ],      "language": "string",      "createdAt": "string"    }  ]}
{  "error": "string"}

Czy ten artykuł był pomocny?

Powiązane artykuły

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