PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/email-deliverabilityEmail delivery settings (BCC/archive, pre-send address validation, third-party validator)
PUT/v1/apps/{appId}/email-deliverabilityUpdate email delivery settings (the validator key is stored with envelope encryption and cannot be read back)
POST/v1/apps/{appId}/email-deliverability/verify-addressAddress validation test (syntax, MX, disposable domain, role account, third party)
GET/v1/apps/{appId}/email-deliverability/warmup-plansWarm-up plans (today's limit/usage and sends reserved for upcoming days)
POST/v1/apps/{appId}/email-deliverability/warmup-plansCreate a warm-up plan (daily limit curve or start/multiplier/target; provider shares)
GET/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Warm-up plan
PATCH/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Update a warm-up plan (pause/resume, curve, shares)
DELETE/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Delete a warm-up plan
GET/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usageWarm-up plan usage by day × provider
GET/v1/apps/{appId}/email-deliverability/hygieneList hygiene status: validation breakdown of email subscriptions and the latest validation run
POST/v1/apps/{appId}/email-deliverability/hygiene-runsValidate the list: validate all email subscriptions in bulk, rate limited (returns the active run if there is one)
GET/v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}List validation run (progress and summary)
POST/v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}/suppressSuppress the addresses found invalid by validation (subscription set to invalid + suppression list)
GET/v1/apps/{appId}/email-deliverability/insightsDelivered, open, click, bounce and complaint counts per mailbox provider (Gmail, Outlook, Yahoo, other)
GET/v1/apps/{appId}/email-deliverability/bouncesEmail bounce trend (2% target), breakdown by type/reason and the recipient domains that bounce most
GET/v1/apps/{appId}/email-deliverability/postmasterGoogle Postmaster reputation records
POST/v1/apps/{appId}/email-deliverability/postmaster/syncRead yesterday's Google Postmaster reputation

Details

Email delivery settings (BCC/archive, pre-send address validation, third-party validator)

GET/v1/apps/{appId}/email-deliverabilityTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailDeliverabilitySettings

FieldTypeRequiredDescription
bcc_addressstring | nullYes
validationobjectYes
validation.enabledbooleanYes
validation.check_mxbooleanYes
validation.block_disposablebooleanYes
validation.block_rolebooleanYes
verifierobjectYes
verifier.providerenum | nullYes
verifier.has_keybooleanYes
volume_spikeobjectYes
volume_spike.multiplierinteger | nullYes
volume_spike.floorinteger | nullYes
postmasterobjectYes
postmaster.domainstring | nullYes
postmaster.has_tokenbooleanYes
max_invalid_rationumberYes

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)

PUT/v1/apps/{appId}/email-deliverabilityTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: DeliverabilitySettingsDto

FieldTypeRequiredDescription
bcc_addressstring (email) | nullNo
validationobjectNo
validation.enabledbooleanYes
validation.check_mxbooleanNo
validation.block_disposablebooleanNo
validation.block_rolebooleanNo
verifierobjectNo
verifier.providerenum | nullYes
verifier.api_keystringNoLength: 8–200
volume_spikeobjectNo
volume_spike.multiplierinteger | nullYes
volume_spike.floorinteger | nullYes
max_invalid_rationumber | nullNo
postmasterobjectNo
postmaster.domainstring | nullYes
postmaster.access_tokenstringNoLength: 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

FieldTypeRequiredDescription
bcc_addressstring | nullYes
validationobjectYes
validation.enabledbooleanYes
validation.check_mxbooleanYes
validation.block_disposablebooleanYes
validation.block_rolebooleanYes
verifierobjectYes
verifier.providerenum | nullYes
verifier.has_keybooleanYes
volume_spikeobjectYes
volume_spike.multiplierinteger | nullYes
volume_spike.floorinteger | nullYes
postmasterobjectYes
postmaster.domainstring | nullYes
postmaster.has_tokenbooleanYes
max_invalid_rationumberYes

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)

POST/v1/apps/{appId}/email-deliverability/verify-addressTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: VerifyAddressDto

FieldTypeRequiredDescription
addressstringYesLength: 3–320

Example:

{
  "address": "örnek"
}

Responses

200 — Success.

Schema: EmailAddressCheck

FieldTypeRequiredDescription
okbooleanYes
reasonenum | nullYes
detailstring | nullYes
checksarray<string>Yes
unknownarray<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)

GET/v1/apps/{appId}/email-deliverability/warmup-plansTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailWarmupPlanList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].kindenumYesValues: "domain", "ip"
data[].targetstringYes
data[].start_datestringYes
data[].daily_limitsarray<integer>Yes
data[].provider_sharesmap<string, number>Yes
data[].timezonestringYes
data[].statusenumYesValues: "active", "paused", "completed"
data[].todayobjectYes
data[].today.daystringYes
data[].today.indexintegerYes
data[].today.limitinteger | nullYes
data[].today.usedintegerYes
data[].today.bucketsmap<string, object>Yes
data[].scheduled_aheadintegerYes
data[].created_atstringYes
data[].updated_atstringYes

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)

POST/v1/apps/{appId}/email-deliverability/warmup-plansTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWarmupPlanDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
kindenumYesValues: "domain", "ip"
targetstringYesLength: 2–253
start_datestringNo
daily_limitsarray<integer>NoItems: 1–120
curveobjectNo
curve.startintegerYesRange: 1–1000000
curve.growthnumberYesRange: 1.05–3
curve.targetintegerYesRange: 1–10000000
provider_sharesobjectNo
provider_shares.gmailnumberYesRange: 0–1
provider_shares.outlooknumberYesRange: 0–1
provider_shares.yahoonumberYesRange: 0–1
provider_shares.othernumberYesRange: 0–1
timezonestringNoLength: 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

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "domain", "ip"
targetstringYes
start_datestringYes
daily_limitsarray<integer>Yes
provider_sharesmap<string, number>Yes
timezonestringYes
statusenumYesValues: "active", "paused", "completed"
todayobjectYes
today.daystringYes
today.indexintegerYes
today.limitinteger | nullYes
today.usedintegerYes
today.bucketsmap<string, object>Yes
scheduled_aheadintegerYes
created_atstringYes
updated_atstringYes

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

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

NameInTypeRequiredDescriptionExample
planIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailWarmupPlan

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "domain", "ip"
targetstringYes
start_datestringYes
daily_limitsarray<integer>Yes
provider_sharesmap<string, number>Yes
timezonestringYes
statusenumYesValues: "active", "paused", "completed"
todayobjectYes
today.daystringYes
today.indexintegerYes
today.limitinteger | nullYes
today.usedintegerYes
today.bucketsmap<string, object>Yes
scheduled_aheadintegerYes
created_atstringYes
updated_atstringYes

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)

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

NameInTypeRequiredDescriptionExample
planIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWarmupPlanDto

FieldTypeRequiredDescription
namestringNoLength: 1–100
statusenumNoValues: "active", "paused"
daily_limitsarray<integer>NoItems: 1–120
provider_sharesobject | nullNo

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

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "domain", "ip"
targetstringYes
start_datestringYes
daily_limitsarray<integer>Yes
provider_sharesmap<string, number>Yes
timezonestringYes
statusenumYesValues: "active", "paused", "completed"
todayobjectYes
today.daystringYes
today.indexintegerYes
today.limitinteger | nullYes
today.usedintegerYes
today.bucketsmap<string, object>Yes
scheduled_aheadintegerYes
created_atstringYes
updated_atstringYes

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

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

NameInTypeRequiredDescriptionExample
planIdpathstringYes"id_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/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Warm-up plan usage by day × provider

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

NameInTypeRequiredDescriptionExample
planIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
daysqueryintegerNoRange: 1–1201
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailWarmupUsage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].daystringYes
data[].bucketstringYes
data[].usedintegerYes
data[].limitinteger | nullYes

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

GET/v1/apps/{appId}/email-deliverability/hygieneTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailHygieneStatus

FieldTypeRequiredDescription
statusobjectYes
status.totalintegerYes
status.validintegerYes
status.invalidintegerYes
status.unknownintegerYes
status.pendingintegerYes
status.uncheckedintegerYes
status.invalid_by_reasonmap<string, integer>Yes
status.unsendableintegerYes
latest_runobject | nullYes

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)

POST/v1/apps/{appId}/email-deliverability/hygiene-runsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: StartHygieneDto

Type: StartHygieneDto

Responses

200 — Success.

Schema: EmailHygieneStart

FieldTypeRequiredDescription
runobjectYes
run.idstringYes
run.app_idstringYes
run.statusenumYesValues: "queued", "running", "completed", "failed"
run.totalintegerYes
run.processedintegerYes
run.validintegerYes
run.invalidintegerYes
run.unknownintegerYes
run.reasonsmap<string, integer>Yes
run.errorstring | nullYes
run.suppressed_countinteger | nullYes
run.suppressed_atstring | nullYes
run.started_atstring | nullYes
run.completed_atstring | nullYes
run.created_atstringYes
run.updated_atstringYes
createdbooleanYes

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)

GET/v1/apps/{appId}/email-deliverability/hygiene-runs/{runId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
runIdpathstringYes"run_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailHygieneRun

FieldTypeRequiredDescription
idstringYes
app_idstringYes
statusenumYesValues: "queued", "running", "completed", "failed"
totalintegerYes
processedintegerYes
validintegerYes
invalidintegerYes
unknownintegerYes
reasonsmap<string, integer>Yes
errorstring | nullYes
suppressed_countinteger | nullYes
suppressed_atstring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes

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)

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

NameInTypeRequiredDescriptionExample
runIdpathstringYes"run_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: StartHygieneDto

Type: StartHygieneDto

Responses

200 — Success.

Schema: EmailHygieneSuppress

FieldTypeRequiredDescription
suppressedintegerYes
runobjectYes
run.idstringYes
run.app_idstringYes
run.statusenumYesValues: "queued", "running", "completed", "failed"
run.totalintegerYes
run.processedintegerYes
run.validintegerYes
run.invalidintegerYes
run.unknownintegerYes
run.reasonsmap<string, integer>Yes
run.errorstring | nullYes
run.suppressed_countinteger | nullYes
run.suppressed_atstring | nullYes
run.started_atstring | nullYes
run.completed_atstring | nullYes
run.created_atstringYes
run.updated_atstringYes

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)

GET/v1/apps/{appId}/email-deliverability/insightsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
daysqueryintegerNoRange: 7–907
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailProviderInsights

FieldTypeRequiredDescription
daysintegerYes
providersarray<object>Yes
providers[].providerenumYesValues: "gmail", "outlook", "yahoo", "other"
providers[].sentintegerYes
providers[].deliveredintegerYes
providers[].openedintegerYes
providers[].clickedintegerYes
providers[].bouncedintegerYes
providers[].complainedintegerYes
trendarray<object>Yes
trend[].daystringYes
trend[].providerenumYesValues: "gmail", "outlook", "yahoo", "other"
trend[].sentintegerYes
trend[].deliveredintegerYes
trend[].bouncedintegerYes

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

GET/v1/apps/{appId}/email-deliverability/bouncesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
daysqueryintegerNoRange: 7–907
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EmailBounceStats

FieldTypeRequiredDescription
daysintegerYes
target_ratenumberYes
suspend_ratenumberYes
rate_7dobjectYes
rate_7d.sentintegerYes
rate_7d.bouncedintegerYes
rate_7d.ratenumber | nullYes
rate_30dobjectYes
rate_30d.sentintegerYes
rate_30d.bouncedintegerYes
rate_30d.ratenumber | nullYes
trendarray<object>Yes
trend[].daystringYes
trend[].sentintegerYes
trend[].bouncedintegerYes
trend[].soft_bouncedintegerYes
trend[].ratenumber | nullYes
by_typeobjectYes
by_type.hardintegerYes
by_type.softintegerYes
by_type.complaintintegerYes
by_type.blocked_before_sendintegerYes
by_reasonarray<object>Yes
by_reason[].codestringYes
by_reason[].countintegerYes
top_domainsarray<object>Yes
top_domains[].domainstringYes
top_domains[].sentintegerYes
top_domains[].bouncedintegerYes
top_domains[].ratenumber | nullYes

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

GET/v1/apps/{appId}/email-deliverability/postmasterTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PostmasterStats

FieldTypeRequiredDescription
domainstring | nullYes
dataarray<object>Yes
data[].daystringYes
data[].domain_reputationstring | nullYes
data[].spam_ratestring | nullYes

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

POST/v1/apps/{appId}/email-deliverability/postmaster/syncTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PostmasterStats

FieldTypeRequiredDescription
domainstring | nullYes
dataarray<object>Yes
data[].daystringYes
data[].domain_reputationstring | nullYes
data[].spam_ratestring | nullYes

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"

On this page