PushizoDocs
API reference

Landing pages

Landing pages — 10 operations (GET /v1/apps/{appId}/landing-pages, POST /v1/apps/{appId}/landing-pages, GET /v1/apps/{appId}/landing-pages/{pageId}, …). Generated from the OpenAPI 3.1.0 contract.

Landing pages built with the block editor: create and update drafts, list, details, publish, unpublish, archive, published versions and delete (published at /lp/<org>/<slug> or a custom domain).

Base URL: https://api.pushizo.com · Tag: landing-pages · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/landing-pagesLanding pages
POST/v1/apps/{appId}/landing-pagesCreate a landing page (draft)
GET/v1/apps/{appId}/landing-pages/{pageId}Landing page details
PATCH/v1/apps/{appId}/landing-pages/{pageId}Update the draft (the published version does not change)
DELETE/v1/apps/{appId}/landing-pages/{pageId}Delete a landing page
POST/v1/apps/{appId}/landing-pages/{pageId}/publishPublish the draft
POST/v1/apps/{appId}/landing-pages/{pageId}/unpublishUnpublish
POST/v1/apps/{appId}/landing-pages/{pageId}/archiveArchive (unpublishes the page and frees its quota)
GET/v1/apps/{appId}/landing-pages/{pageId}/versionsPublished versions
POST/v1/apps/{appId}/landing-pages/{pageId}/versions/{version}/restoreRestore a version to the draft

Details

Landing pages

GET/v1/apps/{appId}/landing-pagesTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "draft", "published", "archived""draft"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].slugstringYes
data[].statusenumYesValues: "draft", "published", "archived"
data[].seoobjectYes
data[].seo.titlestringNoLength: 0–120
data[].seo.descriptionstringNoLength: 0–320
data[].seo.og_imagestring (url)NoLength: 0–2000
data[].seo.canonical_urlstring (url)NoLength: 0–2000
data[].seo.noindexbooleanNo
data[].settingsobjectYes
data[].settings.languagestringNoLength: 2–10
data[].settings.form_idstring | nullNo
data[].settings.form_section_idstring | nullNo
data[].settings.cookie_consentobjectNo
data[].settings.web_sdkbooleanNo
data[].settings.favicon_urlstring (url)NoLength: 0–2000
data[].custom_domain_idstring | nullYes
data[].versionintegerYes
data[].published_versioninteger | nullYes
data[].published_atstring | nullYes
data[].has_unpublished_changesbooleanYes
data[].urlstringYes
data[].domain_urlstring | nullYes
data[].statsobjectYes
data[].stats.submissionsintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "url": "https://pushizo.com/orders/1001",
      "status": "draft",
      "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "slug": "magaza",
      "seo": {
        "title": "Siparişiniz yola çıktı",
        "description": "Sipariş durumu güncellemeleri"
      },
      "settings": {
        "language": "tr",
        "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      },
      "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "version": 1,
      "published_version": 1,
      "published_at": "örnek",
      "has_unpublished_changes": true,
      "domain_url": "https://pushizo.com/orders/1001",
      "stats": {
        "submissions": 1
      },
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create a landing page (draft)

POST/v1/apps/{appId}/landing-pagesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateLandingPageDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
slugstringYesLength: 0–80
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.settings.dark_mode.background_colorstringNo
document.settings.dark_mode.content_background_colorstringNo
document.settings.dark_mode.text_colorstringNo
document.settings.dark_mode.link_colorstringNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].padding.topintegerYesRange: 0–120
document.sections[].padding.rightintegerYesRange: 0–120
document.sections[].padding.bottomintegerYesRange: 0–120
document.sections[].padding.leftintegerYesRange: 0–120
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4
document.sections[].columns[].idstringYes
document.sections[].columns[].width_percentintegerNoRange: 10–100
document.sections[].columns[].background_colorstringNo
document.sections[].columns[].vertical_alignenumNoValues: "top", "middle", "bottom"
document.sections[].columns[].paddingobjectNo
document.sections[].columns[].padding.topintegerYesRange: 0–120
document.sections[].columns[].padding.rightintegerYesRange: 0–120
document.sections[].columns[].padding.bottomintegerYesRange: 0–120
document.sections[].columns[].padding.leftintegerYesRange: 0–120
document.sections[].columns[].blocksarray<object>YesItems: 0–30
seoobjectNo
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectNo
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "document": {
    "version": 1,
    "settings": {
      "width": 480
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer"
      }
    ]
  },
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

201 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "document": {
    "version": 1,
    "settings": {
      "width": 480
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer"
      }
    ]
  },
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Landing page details

GET/v1/apps/{appId}/landing-pages/{pageId}Try it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update the draft (the published version does not change)

PATCH/v1/apps/{appId}/landing-pages/{pageId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateLandingPageDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
slugstringNoLength: 0–80
documentobjectNo
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.settings.dark_mode.background_colorstringNo
document.settings.dark_mode.content_background_colorstringNo
document.settings.dark_mode.text_colorstringNo
document.settings.dark_mode.link_colorstringNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].padding.topintegerYesRange: 0–120
document.sections[].padding.rightintegerYesRange: 0–120
document.sections[].padding.bottomintegerYesRange: 0–120
document.sections[].padding.leftintegerYesRange: 0–120
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4
document.sections[].columns[].idstringYes
document.sections[].columns[].width_percentintegerNoRange: 10–100
document.sections[].columns[].background_colorstringNo
document.sections[].columns[].vertical_alignenumNoValues: "top", "middle", "bottom"
document.sections[].columns[].paddingobjectNo
document.sections[].columns[].padding.topintegerYesRange: 0–120
document.sections[].columns[].padding.rightintegerYesRange: 0–120
document.sections[].columns[].padding.bottomintegerYesRange: 0–120
document.sections[].columns[].padding.leftintegerYesRange: 0–120
document.sections[].columns[].blocksarray<object>YesItems: 0–30
seoobjectNo
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectNo
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "document": {
    "version": 1,
    "settings": {
      "width": 480
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer"
      }
    ]
  },
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  }
}

Responses

200 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "document": {
    "version": 1,
    "settings": {
      "width": 480
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer"
      }
    ]
  },
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  }
}'

Delete a landing page

DELETE/v1/apps/{appId}/landing-pages/{pageId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Publish the draft

POST/v1/apps/{appId}/landing-pages/{pageId}/publishTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/publish" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Unpublish

POST/v1/apps/{appId}/landing-pages/{pageId}/unpublishTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/unpublish" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Archive (unpublishes the page and frees its quota)

POST/v1/apps/{appId}/landing-pages/{pageId}/archiveTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/archive" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Published versions

GET/v1/apps/{appId}/landing-pages/{pageId}/versionsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPageVersions

FieldTypeRequiredDescription
dataarray<object>Yes
data[].versionintegerYes
data[].published_atstringYes
data[].published_bystring | nullYes

Example response:

{
  "data": [
    {
      "version": 1,
      "published_at": "örnek",
      "published_by": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/versions" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Restore a version to the draft

POST/v1/apps/{appId}/landing-pages/{pageId}/versions/{version}/restoreTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
pageIdpathstringYes"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
versionpathnumberYes1.5
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LandingPage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4

Example response:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://pushizo.com/orders/1001",
    "canonical_url": "https://pushizo.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://pushizo.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "örnek"
      }
    ]
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/versions/örnek/restore" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page