Email deliverability
Email deliverability — 17 operations (GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability, POST /v1/apps/{appId}/email-deliverability/verify-address, …). Generated from the OpenAPI 3.1.0 contract.
Sender domain verification (SPF/DKIM/DMARC), warm-up plans, reputation and bounce/complaint summaries.
Base URL: https://api.pushizo.com · Tag: email-deliverability · Interactive docs (Scalar)
Operations
Details
Email delivery settings (BCC/archive, pre-send address validation, third-party validator)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailDeliverabilitySettings
| Field | Type | Required | Description |
|---|---|---|---|
bcc_address | string | null | Yes | |
validation | object | Yes | |
validation.enabled | boolean | Yes | |
validation.check_mx | boolean | Yes | |
validation.block_disposable | boolean | Yes | |
validation.block_role | boolean | Yes | |
verifier | object | Yes | |
verifier.provider | enum | null | Yes | |
verifier.has_key | boolean | Yes | |
volume_spike | object | Yes | |
volume_spike.multiplier | integer | null | Yes | |
volume_spike.floor | integer | null | Yes | |
postmaster | object | Yes | |
postmaster.domain | string | null | Yes | |
postmaster.has_token | boolean | Yes | |
max_invalid_ratio | number | Yes |
Example response:
{
"bcc_address": "örnek",
"validation": {
"enabled": true,
"check_mx": true,
"block_disposable": true,
"block_role": true
},
"verifier": {
"provider": "zerobounce",
"has_key": true
},
"volume_spike": {
"multiplier": 1,
"floor": 1
},
"postmaster": {
"domain": "örnek",
"has_token": true
},
"max_invalid_ratio": 1.5
}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/email-deliverability" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update email delivery settings (the validator key is stored with envelope encryption and cannot be read back)
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: DeliverabilitySettingsDto
| Field | Type | Required | Description |
|---|---|---|---|
bcc_address | string (email) | null | No | |
validation | object | No | |
validation.enabled | boolean | Yes | |
validation.check_mx | boolean | No | |
validation.block_disposable | boolean | No | |
validation.block_role | boolean | No | |
verifier | object | No | |
verifier.provider | enum | null | Yes | |
verifier.api_key | string | No | Length: 8–200 |
volume_spike | object | No | |
volume_spike.multiplier | integer | null | Yes | |
volume_spike.floor | integer | null | Yes | |
max_invalid_ratio | number | null | No | |
postmaster | object | No | |
postmaster.domain | string | null | Yes | |
postmaster.access_token | string | No | Length: 20–4096 |
Example:
{
"bcc_address": "ayse@pushizo.com",
"validation": {
"enabled": true,
"check_mx": true,
"block_disposable": true,
"block_role": true
},
"verifier": {
"provider": "zerobounce",
"api_key": "örnek"
},
"volume_spike": {
"multiplier": 2,
"floor": 1
},
"max_invalid_ratio": 1.5
}Responses
200 — Success.
Schema: EmailDeliverabilitySettings
| Field | Type | Required | Description |
|---|---|---|---|
bcc_address | string | null | Yes | |
validation | object | Yes | |
validation.enabled | boolean | Yes | |
validation.check_mx | boolean | Yes | |
validation.block_disposable | boolean | Yes | |
validation.block_role | boolean | Yes | |
verifier | object | Yes | |
verifier.provider | enum | null | Yes | |
verifier.has_key | boolean | Yes | |
volume_spike | object | Yes | |
volume_spike.multiplier | integer | null | Yes | |
volume_spike.floor | integer | null | Yes | |
postmaster | object | Yes | |
postmaster.domain | string | null | Yes | |
postmaster.has_token | boolean | Yes | |
max_invalid_ratio | number | Yes |
Example response:
{
"bcc_address": "örnek",
"validation": {
"enabled": true,
"check_mx": true,
"block_disposable": true,
"block_role": true
},
"verifier": {
"provider": "zerobounce",
"has_key": true
},
"volume_spike": {
"multiplier": 1,
"floor": 1
},
"postmaster": {
"domain": "örnek",
"has_token": true
},
"max_invalid_ratio": 1.5
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"bcc_address": "ayse@pushizo.com",
"validation": {
"enabled": true,
"check_mx": true,
"block_disposable": true,
"block_role": true
},
"verifier": {
"provider": "zerobounce",
"api_key": "örnek"
},
"volume_spike": {
"multiplier": 2,
"floor": 1
},
"max_invalid_ratio": 1.5
}'Address validation test (syntax, MX, disposable domain, role account, third party)
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: VerifyAddressDto
| Field | Type | Required | Description |
|---|---|---|---|
address | string | Yes | Length: 3–320 |
Example:
{
"address": "örnek"
}Responses
200 — Success.
Schema: EmailAddressCheck
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
reason | enum | null | Yes | |
detail | string | null | Yes | |
checks | array<string> | Yes | |
unknown | array<string> | Yes |
Example response:
{
"ok": true,
"reason": "syntax",
"detail": "örnek",
"checks": [
"örnek"
],
"unknown": [
"ö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/email-deliverability/verify-address" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"address": "örnek"
}'Warm-up plans (today's limit/usage and sends reserved for upcoming days)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailWarmupPlanList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "domain", "ip" |
data[].target | string | Yes | |
data[].start_date | string | Yes | |
data[].daily_limits | array<integer> | Yes | |
data[].provider_shares | map<string, number> | Yes | |
data[].timezone | string | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "completed" |
data[].today | object | Yes | |
data[].today.day | string | Yes | |
data[].today.index | integer | Yes | |
data[].today.limit | integer | null | Yes | |
data[].today.used | integer | Yes | |
data[].today.buckets | map<string, object> | Yes | |
data[].scheduled_ahead | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"target": "örnek",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "domain",
"start_date": "örnek",
"daily_limits": [
1
],
"provider_shares": {
"key": 149.9
},
"timezone": "Europe/Istanbul",
"today": {
"day": "örnek",
"index": 1,
"limit": 50,
"used": 1,
"buckets": {
"key": {}
}
},
"scheduled_ahead": 1,
"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/email-deliverability/warmup-plans" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a warm-up plan (daily limit curve or start/multiplier/target; provider shares)
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: CreateWarmupPlanDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "domain", "ip" |
target | string | Yes | Length: 2–253 |
start_date | string | No | |
daily_limits | array<integer> | No | Items: 1–120 |
curve | object | No | |
curve.start | integer | Yes | Range: 1–1000000 |
curve.growth | number | Yes | Range: 1.05–3 |
curve.target | integer | Yes | Range: 1–10000000 |
provider_shares | object | No | |
provider_shares.gmail | number | Yes | Range: 0–1 |
provider_shares.outlook | number | Yes | Range: 0–1 |
provider_shares.yahoo | number | Yes | Range: 0–1 |
provider_shares.other | number | Yes | Range: 0–1 |
timezone | string | No | Length: 1–64 |
Example:
{
"name": "Sipariş bildirimleri",
"target": "örnek",
"kind": "domain",
"start_date": "değer",
"daily_limits": [
1
],
"curve": {
"target": 1,
"start": 1,
"growth": 1.05
},
"provider_shares": {
"gmail": 1.5,
"outlook": 1.5,
"yahoo": 1.5,
"other": 1.5
},
"timezone": "Europe/Istanbul"
}Responses
201 — Success.
Schema: EmailWarmupPlan
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "domain", "ip" |
target | string | Yes | |
start_date | string | Yes | |
daily_limits | array<integer> | Yes | |
provider_shares | map<string, number> | Yes | |
timezone | string | Yes | |
status | enum | Yes | Values: "active", "paused", "completed" |
today | object | Yes | |
today.day | string | Yes | |
today.index | integer | Yes | |
today.limit | integer | null | Yes | |
today.used | integer | Yes | |
today.buckets | map<string, object> | Yes | |
scheduled_ahead | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "örnek",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "domain",
"start_date": "örnek",
"daily_limits": [
1
],
"provider_shares": {
"key": 149.9
},
"timezone": "Europe/Istanbul",
"today": {
"day": "örnek",
"index": 1,
"limit": 50,
"used": 1,
"buckets": {
"key": {
"limit": 50,
"used": 1
}
}
},
"scheduled_ahead": 1,
"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/email-deliverability/warmup-plans" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"target": "örnek",
"kind": "domain",
"start_date": "değer",
"daily_limits": [
1
],
"curve": {
"target": 1,
"start": 1,
"growth": 1.05
},
"provider_shares": {
"gmail": 1.5,
"outlook": 1.5,
"yahoo": 1.5,
"other": 1.5
},
"timezone": "Europe/Istanbul"
}'Warm-up plan
/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Try it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
planId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailWarmupPlan
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "domain", "ip" |
target | string | Yes | |
start_date | string | Yes | |
daily_limits | array<integer> | Yes | |
provider_shares | map<string, number> | Yes | |
timezone | string | Yes | |
status | enum | Yes | Values: "active", "paused", "completed" |
today | object | Yes | |
today.day | string | Yes | |
today.index | integer | Yes | |
today.limit | integer | null | Yes | |
today.used | integer | Yes | |
today.buckets | map<string, object> | Yes | |
scheduled_ahead | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "örnek",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "domain",
"start_date": "örnek",
"daily_limits": [
1
],
"provider_shares": {
"key": 149.9
},
"timezone": "Europe/Istanbul",
"today": {
"day": "örnek",
"index": 1,
"limit": 50,
"used": 1,
"buckets": {
"key": {
"limit": 50,
"used": 1
}
}
},
"scheduled_ahead": 1,
"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/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a warm-up plan (pause/resume, curve, shares)
/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Try it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
planId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWarmupPlanDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
status | enum | No | Values: "active", "paused" |
daily_limits | array<integer> | No | Items: 1–120 |
provider_shares | object | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"status": "active",
"daily_limits": [
1
],
"provider_shares": {
"gmail": 1.5,
"outlook": 1.5,
"yahoo": 1.5,
"other": 1.5
}
}Responses
200 — Success.
Schema: EmailWarmupPlan
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "domain", "ip" |
target | string | Yes | |
start_date | string | Yes | |
daily_limits | array<integer> | Yes | |
provider_shares | map<string, number> | Yes | |
timezone | string | Yes | |
status | enum | Yes | Values: "active", "paused", "completed" |
today | object | Yes | |
today.day | string | Yes | |
today.index | integer | Yes | |
today.limit | integer | null | Yes | |
today.used | integer | Yes | |
today.buckets | map<string, object> | Yes | |
scheduled_ahead | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "örnek",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "domain",
"start_date": "örnek",
"daily_limits": [
1
],
"provider_shares": {
"key": 149.9
},
"timezone": "Europe/Istanbul",
"today": {
"day": "örnek",
"index": 1,
"limit": 50,
"used": 1,
"buckets": {
"key": {
"limit": 50,
"used": 1
}
}
},
"scheduled_ahead": 1,
"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/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"status": "active",
"daily_limits": [
1
],
"provider_shares": {
"gmail": 1.5,
"outlook": 1.5,
"yahoo": 1.5,
"other": 1.5
}
}'Delete a warm-up plan
/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Try it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
planId | path | string | Yes | "id_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/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Warm-up plan usage by day × provider
/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usageTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
planId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
days | query | integer | No | Range: 1–120 | 1 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailWarmupUsage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].day | string | Yes | |
data[].bucket | string | Yes | |
data[].used | integer | Yes | |
data[].limit | integer | null | Yes |
Example response:
{
"data": [
{
"day": "örnek",
"bucket": "örnek",
"used": 1,
"limit": 50
}
]
}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/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/usage" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"List hygiene status: validation breakdown of email subscriptions and the latest validation run
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailHygieneStatus
| Field | Type | Required | Description |
|---|---|---|---|
status | object | Yes | |
status.total | integer | Yes | |
status.valid | integer | Yes | |
status.invalid | integer | Yes | |
status.unknown | integer | Yes | |
status.pending | integer | Yes | |
status.unchecked | integer | Yes | |
status.invalid_by_reason | map<string, integer> | Yes | |
status.unsendable | integer | Yes | |
latest_run | object | null | Yes |
Example response:
{
"status": {
"total": 1,
"valid": 1,
"invalid": 1,
"unknown": 1,
"pending": 1,
"unchecked": 1,
"invalid_by_reason": {
"key": 150
},
"unsendable": 1
},
"latest_run": {
"status": "queued",
"id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"total": 1,
"processed": 1,
"valid": 1,
"invalid": 1,
"unknown": 1,
"reasons": {
"key": 150
},
"error": "örnek",
"suppressed_count": 1,
"suppressed_at": "örnek",
"started_at": "örnek",
"completed_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/email-deliverability/hygiene" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Validate the list: validate all email subscriptions in bulk, rate limited (returns the active run if there is one)
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: StartHygieneDto
Type: StartHygieneDto
Responses
200 — Success.
Schema: EmailHygieneStart
| Field | Type | Required | Description |
|---|---|---|---|
run | object | Yes | |
run.id | string | Yes | |
run.app_id | string | Yes | |
run.status | enum | Yes | Values: "queued", "running", "completed", "failed" |
run.total | integer | Yes | |
run.processed | integer | Yes | |
run.valid | integer | Yes | |
run.invalid | integer | Yes | |
run.unknown | integer | Yes | |
run.reasons | map<string, integer> | Yes | |
run.error | string | null | Yes | |
run.suppressed_count | integer | null | Yes | |
run.suppressed_at | string | null | Yes | |
run.started_at | string | null | Yes | |
run.completed_at | string | null | Yes | |
run.created_at | string | Yes | |
run.updated_at | string | Yes | |
created | boolean | Yes |
Example response:
{
"run": {
"status": "queued",
"id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"total": 1,
"processed": 1,
"valid": 1,
"invalid": 1,
"unknown": 1,
"reasons": {
"key": 150
},
"error": "örnek",
"suppressed_count": 1,
"suppressed_at": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
},
"created": 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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability/hygiene-runs" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'List validation run (progress and summary)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
runId | path | string | Yes | "run_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailHygieneRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
status | enum | Yes | Values: "queued", "running", "completed", "failed" |
total | integer | Yes | |
processed | integer | Yes | |
valid | integer | Yes | |
invalid | integer | Yes | |
unknown | integer | Yes | |
reasons | map<string, integer> | Yes | |
error | string | null | Yes | |
suppressed_count | integer | null | Yes | |
suppressed_at | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"status": "queued",
"id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"total": 1,
"processed": 1,
"valid": 1,
"invalid": 1,
"unknown": 1,
"reasons": {
"key": 150
},
"error": "örnek",
"suppressed_count": 1,
"suppressed_at": "örnek",
"started_at": "örnek",
"completed_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/email-deliverability/hygiene-runs/run_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Suppress the addresses found invalid by validation (subscription set to invalid + suppression list)
/v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}/suppressTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
runId | path | string | Yes | "run_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: StartHygieneDto
Type: StartHygieneDto
Responses
200 — Success.
Schema: EmailHygieneSuppress
| Field | Type | Required | Description |
|---|---|---|---|
suppressed | integer | Yes | |
run | object | Yes | |
run.id | string | Yes | |
run.app_id | string | Yes | |
run.status | enum | Yes | Values: "queued", "running", "completed", "failed" |
run.total | integer | Yes | |
run.processed | integer | Yes | |
run.valid | integer | Yes | |
run.invalid | integer | Yes | |
run.unknown | integer | Yes | |
run.reasons | map<string, integer> | Yes | |
run.error | string | null | Yes | |
run.suppressed_count | integer | null | Yes | |
run.suppressed_at | string | null | Yes | |
run.started_at | string | null | Yes | |
run.completed_at | string | null | Yes | |
run.created_at | string | Yes | |
run.updated_at | string | Yes |
Example response:
{
"suppressed": 1,
"run": {
"status": "queued",
"id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"total": 1,
"processed": 1,
"valid": 1,
"invalid": 1,
"unknown": 1,
"reasons": {
"key": 150
},
"error": "örnek",
"suppressed_count": 1,
"suppressed_at": "örnek",
"started_at": "örnek",
"completed_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/email-deliverability/hygiene-runs/run_01JD3W5Q7X9K2M4N6P8R0T1V3W/suppress" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Delivered, open, click, bounce and complaint counts per mailbox provider (Gmail, Outlook, Yahoo, other)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
days | query | integer | No | Range: 7–90 | 7 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailProviderInsights
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | Yes | |
providers | array<object> | Yes | |
providers[].provider | enum | Yes | Values: "gmail", "outlook", "yahoo", "other" |
providers[].sent | integer | Yes | |
providers[].delivered | integer | Yes | |
providers[].opened | integer | Yes | |
providers[].clicked | integer | Yes | |
providers[].bounced | integer | Yes | |
providers[].complained | integer | Yes | |
trend | array<object> | Yes | |
trend[].day | string | Yes | |
trend[].provider | enum | Yes | Values: "gmail", "outlook", "yahoo", "other" |
trend[].sent | integer | Yes | |
trend[].delivered | integer | Yes | |
trend[].bounced | integer | Yes |
Example response:
{
"days": 1,
"providers": [
{
"provider": "gmail",
"sent": 1,
"delivered": 1,
"opened": 1,
"clicked": 1,
"bounced": 1,
"complained": 1
}
],
"trend": [
{
"day": "örnek",
"provider": "gmail",
"sent": 1,
"delivered": 1,
"bounced": 1
}
]
}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/email-deliverability/insights" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Email bounce trend (2% target), breakdown by type/reason and the recipient domains that bounce most
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
days | query | integer | No | Range: 7–90 | 7 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EmailBounceStats
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | Yes | |
target_rate | number | Yes | |
suspend_rate | number | Yes | |
rate_7d | object | Yes | |
rate_7d.sent | integer | Yes | |
rate_7d.bounced | integer | Yes | |
rate_7d.rate | number | null | Yes | |
rate_30d | object | Yes | |
rate_30d.sent | integer | Yes | |
rate_30d.bounced | integer | Yes | |
rate_30d.rate | number | null | Yes | |
trend | array<object> | Yes | |
trend[].day | string | Yes | |
trend[].sent | integer | Yes | |
trend[].bounced | integer | Yes | |
trend[].soft_bounced | integer | Yes | |
trend[].rate | number | null | Yes | |
by_type | object | Yes | |
by_type.hard | integer | Yes | |
by_type.soft | integer | Yes | |
by_type.complaint | integer | Yes | |
by_type.blocked_before_send | integer | Yes | |
by_reason | array<object> | Yes | |
by_reason[].code | string | Yes | |
by_reason[].count | integer | Yes | |
top_domains | array<object> | Yes | |
top_domains[].domain | string | Yes | |
top_domains[].sent | integer | Yes | |
top_domains[].bounced | integer | Yes | |
top_domains[].rate | number | null | Yes |
Example response:
{
"days": 1,
"target_rate": 1.5,
"suspend_rate": 1.5,
"rate_7d": {
"sent": 1,
"bounced": 1,
"rate": 1.5
},
"rate_30d": {
"sent": 1,
"bounced": 1,
"rate": 1.5
},
"trend": [
{
"day": "örnek",
"sent": 1,
"bounced": 1,
"soft_bounced": 1,
"rate": 1.5
}
],
"by_type": {
"hard": 1,
"soft": 1,
"complaint": 1,
"blocked_before_send": 1
},
"by_reason": [
{
"code": "örnek",
"count": 1
}
],
"top_domains": [
{
"domain": "örnek",
"sent": 1,
"bounced": 1,
"rate": 1.5
}
]
}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/email-deliverability/bounces" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Google Postmaster reputation records
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PostmasterStats
| Field | Type | Required | Description |
|---|---|---|---|
domain | string | null | Yes | |
data | array<object> | Yes | |
data[].day | string | Yes | |
data[].domain_reputation | string | null | Yes | |
data[].spam_rate | string | null | Yes |
Example response:
{
"data": [
{
"day": "örnek",
"domain_reputation": "örnek",
"spam_rate": "örnek"
}
],
"domain": "ö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/email-deliverability/postmaster" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Read yesterday's Google Postmaster reputation
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PostmasterStats
| Field | Type | Required | Description |
|---|---|---|---|
domain | string | null | Yes | |
data | array<object> | Yes | |
data[].day | string | Yes | |
data[].domain_reputation | string | null | Yes | |
data[].spam_rate | string | null | Yes |
Example response:
{
"data": [
{
"day": "örnek",
"domain_reputation": "örnek",
"spam_rate": "örnek"
}
],
"domain": "ö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/email-deliverability/postmaster/sync" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversations (live chat, WhatsApp, SMS, email)
Conversations (live chat, WhatsApp, SMS, email) — 24 operations (GET /v1/apps/{appId}/ai-agents, POST /v1/apps/{appId}/ai-agents, GET /v1/apps/{appId}/ai-agents/runs, …). Generated from the OpenAPI 3.1.0 contract.
Dynamic Content and Data Feeds
Dynamic Content and Data Feeds — 34 operations (GET /v1/apps/{appId}/data-feeds, POST /v1/apps/{appId}/data-feeds, GET /v1/apps/{appId}/data-feeds/{feedId}, …). Generated from the OpenAPI 3.1.0 contract.