PushizoDocs
API reference

Forms

Forms — 7 operations (GET /v1/apps/{appId}/forms, POST /v1/apps/{appId}/forms, GET /v1/apps/{appId}/forms/{formId}, …). Generated from the OpenAPI 3.1.0 contract.

Bot-protected forms with consent records: definition, submission list and server-side submission (creates a user and email/SMS subscription).

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

Operations

MethodPathOperation
GET/v1/apps/{appId}/formsForms
POST/v1/apps/{appId}/formsCreate a form
GET/v1/apps/{appId}/forms/{formId}Form details
PATCH/v1/apps/{appId}/forms/{formId}Update a form
DELETE/v1/apps/{appId}/forms/{formId}Delete a form (along with its submissions)
GET/v1/apps/{appId}/forms/{formId}/submissionsForm submissions
POST/v1/apps/{appId}/forms/{formId}/submissionsServer-side form submission (if external_id is provided, that user's profile is updated)

Details

Forms

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

Parameters

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

Responses

200 — Success.

Schema: FormPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "active", "archived"
data[].fieldsarray<object>YesItems: 1–20
data[].fields[].idstringYes
data[].fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
data[].fields[].labelmap<string, string>Yes
data[].fields[].placeholdermap<string, string>No
data[].fields[].requiredbooleanNo
data[].fields[].optionsarray<object>NoItems: 0–30
data[].fields[].maps_tostringNo
data[].fields[].max_lengthintegerNoRange: 1–2000
data[].fields[].policy_urlstring (url)NoLength: 0–2000
data[].settingsobjectYes
data[].settings.submit_labelmap<string, string>No
data[].settings.success_messagemap<string, string>No
data[].settings.redirect_urlstring (url)NoLength: 0–2000
data[].settings.tagsmap<string, string>No
data[].settings.subscribeobjectNo
data[].settings.double_opt_inobjectNo
data[].settings.event_namestringNo
data[].settings.captchabooleanNo
data[].settings.default_languagestringNoLength: 2–10
data[].statsobjectYes
data[].stats.submissionsintegerYes
data[].stats.last_submission_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "active",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "fields": [
        {
          "type": "email",
          "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "label": {},
          "placeholder": {},
          "required": true
        }
      ],
      "settings": {
        "tags": {
          "plan": "pro",
          "city": "Istanbul"
        },
        "submit_label": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      },
      "stats": {
        "submissions": 1,
        "last_submission_at": "örnek"
      },
      "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/forms?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create a form

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateFormDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
fieldsarray<object>YesItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectNo
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statusenumNoValues: "active", "archived"

Example:

{
  "name": "Sipariş bildirimleri",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ]
    }
  ],
  "status": "active",
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    }
  }
}

Responses

201 — Success.

Schema: Form

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "active", "archived"
fieldsarray<object>YesItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectYes
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statsobjectYes
stats.submissionsintegerYes
stats.last_submission_atstring | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ],
      "maps_to": "değer"
    }
  ],
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "redirect_url": "https://pushizo.com/orders/1001"
  },
  "stats": {
    "submissions": 1,
    "last_submission_at": "örnek"
  },
  "created_at": "örnek",
  "updated_at": "ö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/forms" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ]
    }
  ],
  "status": "active",
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    }
  }
}'

Form details

GET/v1/apps/{appId}/forms/{formId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
formIdpathstringYes"frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Form

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "active", "archived"
fieldsarray<object>YesItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectYes
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statsobjectYes
stats.submissionsintegerYes
stats.last_submission_atstring | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ],
      "maps_to": "değer"
    }
  ],
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "redirect_url": "https://pushizo.com/orders/1001"
  },
  "stats": {
    "submissions": 1,
    "last_submission_at": "örnek"
  },
  "created_at": "örnek",
  "updated_at": "ö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/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update a form

PATCH/v1/apps/{appId}/forms/{formId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
formIdpathstringYes"frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateFormDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
fieldsarray<object>NoItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectNo
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statusenumNoValues: "active", "archived"

Example:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ]
    }
  ],
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    }
  }
}

Responses

200 — Success.

Schema: Form

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "active", "archived"
fieldsarray<object>YesItems: 1–20
fields[].idstringYes
fields[].typeenumYesValues: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent"
fields[].labelmap<string, string>Yes
fields[].placeholdermap<string, string>No
fields[].requiredbooleanNo
fields[].optionsarray<object>NoItems: 0–30
fields[].options[].valuestringYesLength: 1–100
fields[].options[].labelmap<string, string>Yes
fields[].maps_tostringNo
fields[].max_lengthintegerNoRange: 1–2000
fields[].policy_urlstring (url)NoLength: 0–2000
settingsobjectYes
settings.submit_labelmap<string, string>No
settings.success_messagemap<string, string>No
settings.redirect_urlstring (url)NoLength: 0–2000
settings.tagsmap<string, string>No
settings.subscribeobjectNo
settings.subscribe.emailbooleanNo
settings.subscribe.smsbooleanNo
settings.double_opt_inobjectNo
settings.double_opt_in.enabledbooleanYes
settings.double_opt_in.subjectmap<string, string>No
settings.double_opt_in.bodymap<string, string>No
settings.event_namestringNo
settings.captchabooleanNo
settings.default_languagestringNoLength: 2–10
statsobjectYes
stats.submissionsintegerYes
stats.last_submission_atstring | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ],
      "maps_to": "değer"
    }
  ],
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "redirect_url": "https://pushizo.com/orders/1001"
  },
  "stats": {
    "submissions": 1,
    "last_submission_at": "örnek"
  },
  "created_at": "örnek",
  "updated_at": "ö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/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "fields": [
    {
      "type": "email",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "label": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "placeholder": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      },
      "required": true,
      "options": [
        {
          "value": "user_42",
          "label": {}
        }
      ]
    }
  ],
  "settings": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "submit_label": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    },
    "success_message": {
      "tr": "Siparişiniz yola çıktı",
      "en": "Your order has shipped"
    }
  }
}'

Delete a form (along with its submissions)

DELETE/v1/apps/{appId}/forms/{formId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
formIdpathstringYes"frm_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/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Form submissions

GET/v1/apps/{appId}/forms/{formId}/submissionsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
formIdpathstringYes"frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "accepted", "pending_confirmation", "confirmed""accepted"
sincequerystring (date-time)No"2026-10-17T09:00:00Z"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: FormSubmissionPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].form_idstringYes
data[].user_idstring | nullYes
data[].subscription_idsarray<string>Yes
data[].sourceenumYesValues: "web_campaign", "landing_page", "sdk", "api"
data[].source_idstring | nullYes
data[].statusenumYesValues: "accepted", "pending_confirmation", "confirmed"
data[].datamap<string, string | boolean | array<string>>Yes
data[].consentarray<object>Yes
data[].consent[].field_idstringYes
data[].consent[].givenbooleanYes
data[].consent[].textstringYes
data[].consent[].text_hashstringYes
data[].consent[].policy_urlstring | nullYes
data[].consent[].languagestringYes
data[].consent[].atstringYes
data[].page_urlstring | nullYes
data[].languagestring | nullYes
data[].confirmed_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "data": {
        "order_id": "1001"
      },
      "status": "accepted",
      "id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_ids": [
        "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      ],
      "source": "web_campaign",
      "source_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "consent": [
        {
          "field_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "given": true,
          "text": "Takip bağlantısı içeride",
          "text_hash": "örnek",
          "policy_url": "https://pushizo.com/orders/1001",
          "language": "tr",
          "at": "örnek"
        }
      ],
      "page_url": "https://pushizo.com/orders/1001",
      "language": "tr",
      "confirmed_at": "örnek",
      "created_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/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W/submissions?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Server-side form submission (if external_id is provided, that user's profile is updated)

POST/v1/apps/{appId}/forms/{formId}/submissionsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
formIdpathstringYes"frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PublicFormSubmitDto

FieldTypeRequiredDescription
valuesmap<string, string | boolean | number | array<string>>Yes
external_idstringNoLength: 1–128
page_urlstringNoLength: 0–2000
languagestringNoLength: 2–10

Example:

{
  "values": {
    "key": "user_42"
  },
  "external_id": "user_42",
  "page_url": "https://pushizo.com/orders/1001",
  "language": "tr"
}

Responses

201 — Success.

Schema: FormSubmitResult

FieldTypeRequiredDescription
oktrueYes
statusenumYesValues: "accepted", "pending_confirmation"
submission_idstring | nullYes
success_messagestringYes
redirect_urlstring | nullYes

Example response:

{
  "status": "accepted",
  "ok": true,
  "submission_id": "fsb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "success_message": "örnek",
  "redirect_url": "https://pushizo.com/orders/1001"
}

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/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W/submissions" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "values": {
    "key": "user_42"
  },
  "external_id": "user_42",
  "page_url": "https://pushizo.com/orders/1001",
  "language": "tr"
}'

On this page