Forms

Hosted and embeddable enquiry forms: fields, versioned consent, phone OTP, spam protection, embedding.

GET/v1/forms

Enquiry forms

Hosted and embeddable forms, active ones first.

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

Response · 200

datarequired: array of EnquiryForm
metarequired: object
meta.turnstile_availablerequired: boolean
Turnstile keys are configured.

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "is_active": true,
      "source_id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "fields": [
        {
          "key": "string",
          "kind": "name",
          "label": "string",
          "required": false,
          "placeholder": null,
          "help": null,
          "options": []
        }
      ],
      "consent_text": "string",
      "consent_version": 0,
      "consent_required": true,
      "otp_required": true,
      "spam_protection": "turnstile",
      "success_action": {
        "type": "message",
        "message": "string"
      },
      "title": "string",
      "description": "string",
      "submit_label": "string",
      "allowed_origins": [
        "string"
      ],
      "lead_type": "buy",
      "submissions": 0,
      "public_url": "string",
      "embed_url": "string",
      "embed_snippet": "string",
      "landing_pages": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string",
          "slug": "string"
        }
      ],
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "turnstile_available": true
  }
}

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

Create an enquiry form

Starts with name, mobile, email and message unless `fields` is given. Active forms need marketing.publish.

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

namerequired: string
is_active: boolean
source_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
fields: array of FormFieldInput
consent_text: string or null
consent_required: boolean
otp_required: boolean
spam_protection: FormSpamProtection
success_action: FormSuccessActionInput
Thank-you message, a redirect (https) or a WhatsApp chat.
title: string or null
description: string or null
submit_label: string
allowed_origins: array of string
lead_type: LeadType or null

Response · 201

datarequired: EnquiryForm
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/forms' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","is_active":true,"source_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","fields":[{"key":"string","kind":"name","label":"string","required":false,"placeholder":null,"help":null,"options":[]}],"consent_text":"string","consent_required":true,"otp_required":true,"spam_protection":"turnstile","success_action":{"type":"message","message":"string"},"title":"string","description":"string","submit_label":"string","allowed_origins":["https://www.example.com"],"lead_type":"buy"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "is_active": true,
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "fields": [
      {
        "key": "string",
        "kind": "name",
        "label": "string",
        "required": false,
        "placeholder": null,
        "help": null,
        "options": []
      }
    ],
    "consent_text": "string",
    "consent_version": 0,
    "consent_required": true,
    "otp_required": true,
    "spam_protection": "turnstile",
    "success_action": {
      "type": "message",
      "message": "string"
    },
    "title": "string",
    "description": "string",
    "submit_label": "string",
    "allowed_origins": [
      "string"
    ],
    "lead_type": "buy",
    "submissions": 0,
    "public_url": "string",
    "embed_url": "string",
    "embed_snippet": "string",
    "landing_pages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "slug": "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.

GET/v1/forms/{id}

An enquiry form

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: EnquiryForm
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "is_active": true,
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "fields": [
      {
        "key": "string",
        "kind": "name",
        "label": "string",
        "required": false,
        "placeholder": null,
        "help": null,
        "options": []
      }
    ],
    "consent_text": "string",
    "consent_version": 0,
    "consent_required": true,
    "otp_required": true,
    "spam_protection": "turnstile",
    "success_action": {
      "type": "message",
      "message": "string"
    },
    "title": "string",
    "description": "string",
    "submit_label": "string",
    "allowed_origins": [
      "string"
    ],
    "lead_type": "buy",
    "submissions": 0,
    "public_url": "string",
    "embed_url": "string",
    "embed_snippet": "string",
    "landing_pages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "slug": "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/forms/{id}

Update an enquiry form

Changing the consent text bumps its version; switching a form on or off 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.

Request body

name: string
is_active: boolean
source_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
fields: array of FormFieldInput
consent_text: string or null
consent_required: boolean
otp_required: boolean
spam_protection: FormSpamProtection
success_action: FormSuccessActionInput
Thank-you message, a redirect (https) or a WhatsApp chat.
title: string or null
description: string or null
submit_label: string
allowed_origins: array of string
lead_type: LeadType or null

Response · 200

datarequired: EnquiryForm
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/forms/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","is_active":true,"source_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","fields":[{"key":"string","kind":"name","label":"string","required":false,"placeholder":null,"help":null,"options":[]}],"consent_text":"string","consent_required":true,"otp_required":true,"spam_protection":"turnstile","success_action":{"type":"message","message":"string"},"title":"string","description":"string","submit_label":"string","allowed_origins":["https://www.example.com"],"lead_type":"buy"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "is_active": true,
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "fields": [
      {
        "key": "string",
        "kind": "name",
        "label": "string",
        "required": false,
        "placeholder": null,
        "help": null,
        "options": []
      }
    ],
    "consent_text": "string",
    "consent_version": 0,
    "consent_required": true,
    "otp_required": true,
    "spam_protection": "turnstile",
    "success_action": {
      "type": "message",
      "message": "string"
    },
    "title": "string",
    "description": "string",
    "submit_label": "string",
    "allowed_origins": [
      "string"
    ],
    "lead_type": "buy",
    "submissions": 0,
    "public_url": "string",
    "embed_url": "string",
    "embed_snippet": "string",
    "landing_pages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "slug": "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/forms/{id}

Delete an unused enquiry form

A form with submissions or on a landing page answers 409 — switch it off instead.

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.deletedrequired: true
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": 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.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "is_active": true, "source_id": "cmusrceel0000q7kaafxqi1om", "project_id": "cmusrceel0000q7kaafxqi1om", "fields": [ { "key": "string", "kind": "name", "label": "string", "required": false, "placeholder": null, "help": null, "options": [] } ], "consent_text": "string", "consent_version": 0, "consent_required": true, "otp_required": true, "spam_protection": "turnstile", "success_action": { "type": "message", "message": "string" }, "title": "string", "description": "string", "submit_label": "string", "allowed_origins": [ "string" ], "lead_type": "buy", "submissions": 0, "public_url": "string", "embed_url": "string", "embed_snippet": "string", "landing_pages": [ { "id": "cmusrceel0000q7kaafxqi1om", "title": "string", "slug": "string" } ], "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "turnstile_available": true } }

curl -X POST 'https://api.propzolo.com/v1/forms' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","is_active":true,"source_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","fields":[{"key":"string","kind":"name","label":"string","required":false,"placeholder":null,"help":null,"options":[]}],"consent_text":"string","consent_required":true,"otp_required":true,"spam_protection":"turnstile","success_action":{"type":"message","message":"string"},"title":"string","description":"string","submit_label":"string","allowed_origins":["https://www.example.com"],"lead_type":"buy"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "is_active": true, "source_id": "cmusrceel0000q7kaafxqi1om", "project_id": "cmusrceel0000q7kaafxqi1om", "fields": [ { "key": "string", "kind": "name", "label": "string", "required": false, "placeholder": null, "help": null, "options": [] } ], "consent_text": "string", "consent_version": 0, "consent_required": true, "otp_required": true, "spam_protection": "turnstile", "success_action": { "type": "message", "message": "string" }, "title": "string", "description": "string", "submit_label": "string", "allowed_origins": [ "string" ], "lead_type": "buy", "submissions": 0, "public_url": "string", "embed_url": "string", "embed_snippet": "string", "landing_pages": [ { "id": "cmusrceel0000q7kaafxqi1om", "title": "string", "slug": "string" } ], "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/forms/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","is_active":true,"source_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","fields":[{"key":"string","kind":"name","label":"string","required":false,"placeholder":null,"help":null,"options":[]}],"consent_text":"string","consent_required":true,"otp_required":true,"spam_protection":"turnstile","success_action":{"type":"message","message":"string"},"title":"string","description":"string","submit_label":"string","allowed_origins":["https://www.example.com"],"lead_type":"buy"}'