Landing pages

Project, listing and campaign pages from template blocks, with the RERA publish rules and SEO.

GET/v1/landing-pages

Landing pages

Draft and published pages and microsites (archived ones are hidden), most recently changed first.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Response · 200

datarequired: array of LandingPage
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/landing-pages' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "slug": "string",
      "template": "project",
      "status": "draft",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string"
      },
      "member": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "form": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_active": true
      },
      "domain": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "hostname": "string"
      },
      "blocks": [
        {
          "type": "hero",
          "heading": "string",
          "subheading": null,
          "cta_label": "Enquire now",
          "show_price": true,
          "layout": "stacked"
        }
      ],
      "theme": {
        "preset": "clean",
        "appearance": "auto",
        "accent": "brand",
        "corners": "soft"
      },
      "settings": {
        "price_policy": "show"
      },
      "seo": {
        "title": null,
        "description": null,
        "noindex": false,
        "image_media_id": null
      },
      "tracking": {
        "mode": "inherit",
        "meta_pixel_id": "string",
        "ga4_id": "string",
        "gtm_id": "string",
        "google_ads_id": "string",
        "google_ads_label": "string"
      },
      "experiment": {
        "round": 0,
        "started_at": null,
        "variants": [
          {
            "key": "a",
            "name": "string",
            "weight": 0,
            "blocks": null
          }
        ]
      },
      "published_at": "2026-10-06T05:30:00.000Z",
      "live_version": {
        "number": 0,
        "published_at": "2026-10-06T05:30:00.000Z"
      },
      "version_count": 0,
      "has_unpublished_changes": true,
      "views": 0,
      "visitors": 0,
      "conversions": 0,
      "public_url": "string",
      "issues": [
        "string"
      ],
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages

Create a landing page

A draft from the template of a project, a listing, a campaign or an agent; the slug follows the title.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

title: string
slug: string
template: LandingTemplate
project_id: Id or null
Opaque record id.
property_id: Id or null
Opaque record id.
member_id: Id or null
Opaque record id.
form_id: Id or null
Opaque record id.
domain_id: Id or null
Opaque record id.
blocks: array of LandingBlockInput
Each block type appears at most once; a page needs a hero (or an agent card).
theme: object
theme.preset: "clean" | "bold" | "minimal"
theme.appearance: "auto" | "light" | "dark"
theme.accent: "brand" | "indigo" | "emerald" | "amber" | "rose" | "teal" | …
theme.corners: "soft" | "sharp" | "round"
settings: object
settings.price_policy: "show" | "from" | "on_request"
seo: object
seo.title: string or null
seo.description: string or null
seo.noindex: boolean
seo.image_media_id: Id or null
Opaque record id.
tracking: object
tracking.mode: "inherit" | "custom" | "off"
tracking.meta_pixel_id: string or null
tracking.ga4_id: string or null
tracking.gtm_id: string or null
tracking.google_ads_id: string or null
tracking.google_ads_label: string or null
experiment: LandingExperimentInput or null
An A/B test: the original (`a`, the page’s blocks) first, then up to three variants with their blocks.

Response · 201

datarequired: LandingPage
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"title":"string","slug":"string","template":"project","project_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","member_id":"cmusrceel0000q7kaafxqi1om","form_id":"cmusrceel0000q7kaafxqi1om","domain_id":"cmusrceel0000q7kaafxqi1om","blocks":[{"type":"hero","heading":"string","subheading":null,"cta_label":"Enquire now","show_price":true,"layout":"stacked"}],"theme":{"preset":"clean","appearance":"auto","accent":"brand","corners":"soft"},"settings":{"price_policy":"show"},"seo":{"title":"string","description":"string","noindex":true,"image_media_id":"cmusrceel0000q7kaafxqi1om"},"tracking":{"mode":"inherit","meta_pixel_id":"string","ga4_id":"string","gtm_id":"string","google_ads_id":"string","google_ads_label":"string"},"experiment":{"round":0,"started_at":null,"variants":[{"key":"a","name":"string","weight":0,"blocks":null}]}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages/microsites

Create a listing microsite or an agent card

Generated from the listing (photos, specs, price, map, agent, enquiry form) or the member (photo, RERA number, call / WhatsApp, live listings). Asking again returns the existing page; `publish` puts it live when it is ready.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

No fields.

Response · 200

datarequired: object
data.pagerequired: LandingPage
data.createdrequired: boolean
data.publishedrequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages/microsites' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"listing","property_id":"cmusrceel0000q7kaafxqi1om","publish":false}'

Response example

{
  "data": {
    "page": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "slug": "string",
      "template": "project",
      "status": "draft",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string"
      },
      "member": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "form": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_active": true
      },
      "domain": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "hostname": "string"
      },
      "blocks": [
        {
          "type": "hero",
          "heading": "string",
          "subheading": null,
          "cta_label": "Enquire now",
          "show_price": true,
          "layout": "stacked"
        }
      ],
      "theme": {
        "preset": "clean",
        "appearance": "auto",
        "accent": "brand",
        "corners": "soft"
      },
      "settings": {
        "price_policy": "show"
      },
      "seo": {
        "title": null,
        "description": null,
        "noindex": false,
        "image_media_id": null
      },
      "tracking": {
        "mode": "inherit",
        "meta_pixel_id": "string",
        "ga4_id": "string",
        "gtm_id": "string",
        "google_ads_id": "string",
        "google_ads_label": "string"
      },
      "experiment": {
        "round": 0,
        "started_at": null,
        "variants": [
          {
            "key": "a",
            "name": "string",
            "weight": 0,
            "blocks": null
          }
        ]
      },
      "published_at": "2026-10-06T05:30:00.000Z",
      "live_version": {
        "number": 0,
        "published_at": "2026-10-06T05:30:00.000Z"
      },
      "version_count": 0,
      "has_unpublished_changes": true,
      "views": 0,
      "visitors": 0,
      "conversions": 0,
      "public_url": "string",
      "issues": [
        "string"
      ],
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "created": true,
    "published": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/landing-pages/{id}

A landing page

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LandingPage
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/landing-pages/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/landing-pages/{id}

Update a landing page’s draft

Blocks, theme, price policy, form, slug, domain, SEO, tracking and the A/B test of the draft.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

title: string
slug: string
project_id: Id or null
Opaque record id.
property_id: Id or null
Opaque record id.
member_id: Id or null
Opaque record id.
form_id: Id or null
Opaque record id.
domain_id: Id or null
Opaque record id.
blocks: array of LandingBlockInput
Each block type appears at most once; a page needs a hero (or an agent card).
theme: object
theme.preset: "clean" | "bold" | "minimal"
theme.appearance: "auto" | "light" | "dark"
theme.accent: "brand" | "indigo" | "emerald" | "amber" | "rose" | "teal" | …
theme.corners: "soft" | "sharp" | "round"
settings: object
settings.price_policy: "show" | "from" | "on_request"
seo: object
seo.title: string or null
seo.description: string or null
seo.noindex: boolean
seo.image_media_id: Id or null
Opaque record id.
tracking: object
tracking.mode: "inherit" | "custom" | "off"
tracking.meta_pixel_id: string or null
tracking.ga4_id: string or null
tracking.gtm_id: string or null
tracking.google_ads_id: string or null
tracking.google_ads_label: string or null
experiment: LandingExperiment2 or null
An A/B test: the original (`a`, the page’s blocks) first, then up to three variants with their blocks.

Response · 200

datarequired: LandingPage
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/landing-pages/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"title":"string","slug":"string","project_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","member_id":"cmusrceel0000q7kaafxqi1om","form_id":"cmusrceel0000q7kaafxqi1om","domain_id":"cmusrceel0000q7kaafxqi1om","blocks":[{"type":"hero","heading":"string","subheading":null,"cta_label":"Enquire now","show_price":true,"layout":"stacked"}],"theme":{"preset":"clean","appearance":"auto","accent":"brand","corners":"soft"},"settings":{"price_policy":"show"},"seo":{"title":"string","description":"string","noindex":true,"image_media_id":"cmusrceel0000q7kaafxqi1om"},"tracking":{"mode":"inherit","meta_pixel_id":"string","ga4_id":"string","gtm_id":"string","google_ads_id":"string","google_ads_label":"string"},"experiment":{"round":0,"started_at":null,"variants":[{"key":"a","name":"string","weight":0,"blocks":null}]}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/landing-pages/{id}

Delete or archive a landing page

An unused draft is deleted; a page with views, enquiries or versions is archived. Unpublish first.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.archivedrequired: boolean
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/landing-pages/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "archived": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/landing-pages/{id}/analytics

Landing page analytics

Views, visitors, enquiries and contact taps per company day (bots filtered), and the A/B test’s results with a significance hint.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.
daysquery: integer

Response · 200

datarequired: LandingAnalytics
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/landing-pages/{id}/analytics' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "totals": {
      "views": 0,
      "visitors": 0,
      "conversions": 0
    },
    "from": "string",
    "to": "string",
    "daily": [
      {
        "day": "string",
        "views": 0,
        "visitors": 0,
        "conversions": 0,
        "contacts": 0
      }
    ],
    "experiment": {
      "round": 0,
      "started_at": "string",
      "live": true,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "views": 0,
          "visitors": 0,
          "conversions": 0,
          "rate": 0,
          "comparison": {
            "rate": 0,
            "control_rate": 0,
            "lift": 0,
            "z": 0,
            "p_value": 0,
            "probability_better": 0,
            "hint": "not_enough_data"
          },
          "hint": "string"
        }
      ]
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages/{id}/experiment/winner

End an A/B test with a winner

The winner becomes the page and the test ends; a live page is republished at once.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.publish.

Parameters

idpathrequired: Id
Opaque record id.

Request body

variantrequired: LandingVariantKey

Response · 200

datarequired: LandingPage
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages/{id}/experiment/winner' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"variant":"a"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages/{id}/preview-link

A preview link of the draft

Shows the draft exactly as visitors would for two hours; nothing on it counts or tracks.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages/{id}/preview-link' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages/{id}/publish

Publish a landing page

Puts the draft live as a new version; 422 with the first issue while the draft is not ready, 402 when the plan has no room for another live page.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.publish.

Parameters

idpathrequired: Id
Opaque record id.

Request body (optional)

note: string or null

Response · 200

datarequired: LandingPage
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages/{id}/publish' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages/{id}/unpublish

Unpublish a landing page

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.publish.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LandingPage
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages/{id}/unpublish' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/landing-pages/{id}/versions

Published versions of a landing page

The last 50, newest first.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of LandingVersion
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/landing-pages/{id}/versions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z",
      "published_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "note": "string",
      "is_live": true,
      "ab_test": true
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/landing-pages/{id}/versions/{number}/restore

Restore a version (rollback)

Copies the version into the draft; with `publish` it goes live at once as a new version (needs marketing.publish).

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.edit.

Parameters

idpathrequired: Id
Opaque record id.
numberpathrequired: integer

Request body

publish: boolean

Response · 200

datarequired: LandingPage
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/landing-pages/{id}/versions/{number}/restore' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"publish":false}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "title": "string",
    "slug": "string",
    "template": "project",
    "status": "draft",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "form": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true
    },
    "domain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "hostname": "string"
    },
    "blocks": [
      {
        "type": "hero",
        "heading": "string",
        "subheading": null,
        "cta_label": "Enquire now",
        "show_price": true,
        "layout": "stacked"
      }
    ],
    "theme": {
      "preset": "clean",
      "appearance": "auto",
      "accent": "brand",
      "corners": "soft"
    },
    "settings": {
      "price_policy": "show"
    },
    "seo": {
      "title": null,
      "description": null,
      "noindex": false,
      "image_media_id": null
    },
    "tracking": {
      "mode": "inherit",
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "experiment": {
      "round": 0,
      "started_at": null,
      "variants": [
        {
          "key": "a",
          "name": "string",
          "weight": 0,
          "blocks": null
        }
      ]
    },
    "published_at": "2026-10-06T05:30:00.000Z",
    "live_version": {
      "number": 0,
      "published_at": "2026-10-06T05:30:00.000Z"
    },
    "version_count": 0,
    "has_unpublished_changes": true,
    "views": 0,
    "visitors": 0,
    "conversions": 0,
    "public_url": "string",
    "issues": [
      "string"
    ],
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/site-chat

Site chat settings

Whether published landing pages and microsites show the AI property chat, and its greeting.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Response · 200

datarequired: SiteChatSettings
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/site-chat' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "enabled": true,
    "greeting": "string",
    "daily_credit_cap": 200,
    "daily_session_cap": 300
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/site-chat

Save the site chat settings

Switching it on publishes an AI chat on the public pages (answers use AI credits). Audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.publish.

Request body

enabledrequired: boolean
greetingrequired: string
daily_credit_cap: integer
daily_session_cap: integer

Response · 200

datarequired: SiteChatSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/site-chat' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"greeting":"string","daily_credit_cap":200,"daily_session_cap":300}'

Response example

{
  "data": {
    "enabled": true,
    "greeting": "string",
    "daily_credit_cap": 200,
    "daily_session_cap": 300
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/site-domains

Custom domains

The company’s own domains for its pages, with the DNS records to add and the plan’s limit.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.view or marketing.view.

Response · 200

datarequired: object
data.domainsrequired: array of SiteDomain
data.limitrequired: integer or null
data.cname_targetrequired: string or null
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/site-domains' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "domains": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "hostname": "string",
        "status": "pending",
        "ssl_status": "string",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "checked_at": "2026-10-06T05:30:00.000Z",
        "records": [
          {
            "type": "CNAME",
            "name": "string",
            "host": "string",
            "value": "string"
          }
        ],
        "home_page": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string",
          "slug": "string",
          "published": true
        },
        "last_error": "string",
        "url": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "limit": 0,
    "cname_target": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/site-domains

Add a custom domain

A sub-domain the company owns (homes.acme.in). It serves pages once the CNAME is in place and Cloudflare confirmed ownership and the certificate. Needs a recent two-factor check.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.company.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

hostnamerequired: string
home_page_id: Id or null
Opaque record id.

Response · 201

datarequired: SiteDomain
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/site-domains' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"hostname":"string","home_page_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string",
    "status": "pending",
    "ssl_status": "string",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "checked_at": "2026-10-06T05:30:00.000Z",
    "records": [
      {
        "type": "CNAME",
        "name": "string",
        "host": "string",
        "value": "string"
      }
    ],
    "home_page": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "slug": "string",
      "published": true
    },
    "last_error": "string",
    "url": "string",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/site-domains/{id}

Change a domain’s home page

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.company.

Parameters

idpathrequired: Id
Opaque record id.

Request body

home_page_idrequired: Id or null
Opaque record id.

Response · 200

datarequired: SiteDomain
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/site-domains/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"home_page_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string",
    "status": "pending",
    "ssl_status": "string",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "checked_at": "2026-10-06T05:30:00.000Z",
    "records": [
      {
        "type": "CNAME",
        "name": "string",
        "host": "string",
        "value": "string"
      }
    ],
    "home_page": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "slug": "string",
      "published": true
    },
    "last_error": "string",
    "url": "string",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/site-domains/{id}

Remove a custom domain

Stops serving at once; the hostname is released at Cloudflare in the background.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.company.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.hostnamerequired: string
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/site-domains/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/site-domains/{id}/check

Check a domain now

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.company.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SiteDomain
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/site-domains/{id}/check' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string",
    "status": "pending",
    "ssl_status": "string",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "checked_at": "2026-10-06T05:30:00.000Z",
    "records": [
      {
        "type": "CNAME",
        "name": "string",
        "host": "string",
        "value": "string"
      }
    ],
    "home_page": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string",
      "slug": "string",
      "published": true
    },
    "last_error": "string",
    "url": "string",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/site-settings

Website tracking and consent

The tags every page inherits, the consent banner’s words and the microsite defaults.

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.view.

Response · 200

datarequired: SiteSettings
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/site-settings' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "tracking": {
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "forms_tracking": true,
    "consent": {
      "banner_text": "string",
      "privacy_url": "string"
    },
    "microsites": {
      "form_id": "cmusrceel0000q7kaafxqi1om",
      "theme": {
        "preset": "clean",
        "appearance": "auto",
        "accent": "brand",
        "corners": "soft"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/site-settings

Change website tracking and consent

Access: Signed-in members only (web or Android session) — not for API keys. Permission marketing.publish.

Request body

tracking: object
tracking.meta_pixel_id: string or null
tracking.ga4_id: string or null
tracking.gtm_id: string or null
tracking.google_ads_id: string or null
tracking.google_ads_label: string or null
forms_tracking: boolean
consent: object
consent.banner_text: string or null
consent.privacy_url: string or null
microsites: object
microsites.form_id: Id or null
Opaque record id.
microsites.theme: object or null
microsites.theme.preset: "clean" | "bold" | "minimal"
microsites.theme.appearance: "auto" | "light" | "dark"
microsites.theme.accent: "brand" | "indigo" | "emerald" | "amber" | "rose" | "teal" | …
microsites.theme.corners: "soft" | "sharp" | "round"

Response · 200

datarequired: SiteSettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/site-settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"tracking":{"meta_pixel_id":"string","ga4_id":"string","gtm_id":"string","google_ads_id":"string","google_ads_label":"string"},"forms_tracking":true,"consent":{"banner_text":"string","privacy_url":"string"},"microsites":{"form_id":"cmusrceel0000q7kaafxqi1om","theme":{"preset":"clean","appearance":"auto","accent":"brand","corners":"soft"}}}'

Response example

{
  "data": {
    "tracking": {
      "meta_pixel_id": "string",
      "ga4_id": "string",
      "gtm_id": "string",
      "google_ads_id": "string",
      "google_ads_label": "string"
    },
    "forms_tracking": true,
    "consent": {
      "banner_text": "string",
      "privacy_url": "string"
    },
    "microsites": {
      "form_id": "cmusrceel0000q7kaafxqi1om",
      "theme": {
        "preset": "clean",
        "appearance": "auto",
        "accent": "brand",
        "corners": "soft"
      }
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.