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
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/forms | Forms |
POST | /v1/apps/{appId}/forms | Create 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}/submissions | Form submissions |
POST | /v1/apps/{appId}/forms/{formId}/submissions | Server-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
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
status | query | enum | No | Values: "active", "archived" | "active" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: FormPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "active", "archived" |
data[].fields | array<object> | Yes | Items: 1–20 |
data[].fields[].id | string | Yes | |
data[].fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
data[].fields[].label | map<string, string> | Yes | |
data[].fields[].placeholder | map<string, string> | No | |
data[].fields[].required | boolean | No | |
data[].fields[].options | array<object> | No | Items: 0–30 |
data[].fields[].maps_to | string | No | |
data[].fields[].max_length | integer | No | Range: 1–2000 |
data[].fields[].policy_url | string (url) | No | Length: 0–2000 |
data[].settings | object | Yes | |
data[].settings.submit_label | map<string, string> | No | |
data[].settings.success_message | map<string, string> | No | |
data[].settings.redirect_url | string (url) | No | Length: 0–2000 |
data[].settings.tags | map<string, string> | No | |
data[].settings.subscribe | object | No | |
data[].settings.double_opt_in | object | No | |
data[].settings.event_name | string | No | |
data[].settings.captcha | boolean | No | |
data[].settings.default_language | string | No | Length: 2–10 |
data[].stats | object | Yes | |
data[].stats.submissions | integer | Yes | |
data[].stats.last_submission_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateFormDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
fields | array<object> | Yes | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | No | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
status | enum | No | Values: "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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "archived" |
fields | array<object> | Yes | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | Yes | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
stats | object | Yes | |
stats.submissions | integer | Yes | |
stats.last_submission_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
formId | path | string | Yes | "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Form
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "archived" |
fields | array<object> | Yes | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | Yes | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
stats | object | Yes | |
stats.submissions | integer | Yes | |
stats.last_submission_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
formId | path | string | Yes | "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateFormDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
fields | array<object> | No | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | No | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
status | enum | No | Values: "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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "active", "archived" |
fields | array<object> | Yes | Items: 1–20 |
fields[].id | string | Yes | |
fields[].type | enum | Yes | Values: "email", "phone", "first_name", "last_name", "full_name", "text", "textarea", "select", "radio", "checkbox", "consent" |
fields[].label | map<string, string> | Yes | |
fields[].placeholder | map<string, string> | No | |
fields[].required | boolean | No | |
fields[].options | array<object> | No | Items: 0–30 |
fields[].options[].value | string | Yes | Length: 1–100 |
fields[].options[].label | map<string, string> | Yes | |
fields[].maps_to | string | No | |
fields[].max_length | integer | No | Range: 1–2000 |
fields[].policy_url | string (url) | No | Length: 0–2000 |
settings | object | Yes | |
settings.submit_label | map<string, string> | No | |
settings.success_message | map<string, string> | No | |
settings.redirect_url | string (url) | No | Length: 0–2000 |
settings.tags | map<string, string> | No | |
settings.subscribe | object | No | |
settings.subscribe.email | boolean | No | |
settings.subscribe.sms | boolean | No | |
settings.double_opt_in | object | No | |
settings.double_opt_in.enabled | boolean | Yes | |
settings.double_opt_in.subject | map<string, string> | No | |
settings.double_opt_in.body | map<string, string> | No | |
settings.event_name | string | No | |
settings.captcha | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
stats | object | Yes | |
stats.submissions | integer | Yes | |
stats.last_submission_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
formId | path | string | Yes | "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
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
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
formId | path | string | Yes | "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
status | query | enum | No | Values: "accepted", "pending_confirmation", "confirmed" | "accepted" |
since | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: FormSubmissionPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].form_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].subscription_ids | array<string> | Yes | |
data[].source | enum | Yes | Values: "web_campaign", "landing_page", "sdk", "api" |
data[].source_id | string | null | Yes | |
data[].status | enum | Yes | Values: "accepted", "pending_confirmation", "confirmed" |
data[].data | map<string, string | boolean | array<string>> | Yes | |
data[].consent | array<object> | Yes | |
data[].consent[].field_id | string | Yes | |
data[].consent[].given | boolean | Yes | |
data[].consent[].text | string | Yes | |
data[].consent[].text_hash | string | Yes | |
data[].consent[].policy_url | string | null | Yes | |
data[].consent[].language | string | Yes | |
data[].consent[].at | string | Yes | |
data[].page_url | string | null | Yes | |
data[].language | string | null | Yes | |
data[].confirmed_at | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
formId | path | string | Yes | "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: PublicFormSubmitDto
| Field | Type | Required | Description |
|---|---|---|---|
values | map<string, string | boolean | number | array<string>> | Yes | |
external_id | string | No | Length: 1–128 |
page_url | string | No | Length: 0–2000 |
language | string | No | Length: 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
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
status | enum | Yes | Values: "accepted", "pending_confirmation" |
submission_id | string | null | Yes | |
success_message | string | Yes | |
redirect_url | string | null | Yes |
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"
}'Site search
Site search — 11 operations (GET /v1/apps/{appId}/site-search, PATCH /v1/apps/{appId}/site-search/settings, GET /v1/apps/{appId}/site-search/sources, …). Generated from the OpenAPI 3.1.0 contract.
Surveys and NPS
Surveys and NPS — 10 operations (GET /v1/apps/{appId}/surveys, POST /v1/apps/{appId}/surveys, GET /v1/apps/{appId}/surveys/{surveyId}, …). Generated from the OpenAPI 3.1.0 contract.