PushizoDocs
API referansı

E-posta teslim edilebilirliği

E-posta teslim edilebilirliği — 9 işlem (GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability, POST /v1/apps/{appId}/email-deliverability/verify-address, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Gönderici alan adı doğrulaması (SPF/DKIM/DMARC), ısındırma (warm-up) planı, itibar ve bounce/şikâyet özetleri.

Taban adres: https://api.pushizo.com · Etiket: email-deliverability · Etkileşimli belge (Scalar)

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/email-deliverabilityE-posta teslim ayarları (BCC/arşiv, gönderim öncesi adres doğrulama, üçüncü taraf doğrulayıcı)
PUT/v1/apps/{appId}/email-deliverabilityE-posta teslim ayarlarını güncelle (doğrulayıcı anahtarı zarf şifreli saklanır, geri okunmaz)
POST/v1/apps/{appId}/email-deliverability/verify-addressAdres doğrulama testi (sözdizimi, MX, tek kullanımlık alan adı, rol hesabı, üçüncü taraf)
GET/v1/apps/{appId}/email-deliverability/warmup-plansIsındırma planları (bugünkü limit/kullanım ve ileri günlere ayrılmış gönderimler)
POST/v1/apps/{appId}/email-deliverability/warmup-plansIsındırma planı oluştur (günlük limit eğrisi veya başlangıç/çarpan/hedef; sağlayıcı payları)
GET/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Isındırma planı
PATCH/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Isındırma planını güncelle (duraklat/sürdür, eğri, paylar)
DELETE/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Isındırma planını sil
GET/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usageIsındırma planı gün × sağlayıcı kullanımı

Ayrıntılar

E-posta teslim ayarları (BCC/arşiv, gönderim öncesi adres doğrulama, üçüncü taraf doğrulayıcı)

GET/v1/apps/{appId}/email-deliverabilityDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: EmailDeliverabilitySettings

AlanTürZorunluAçıklama
bcc_addressstring | nullEvet
validationobjectEvet
validation.enabledbooleanEvet
validation.check_mxbooleanEvet
validation.block_disposablebooleanEvet
validation.block_rolebooleanEvet
verifierobjectEvet
verifier.providerenum | nullEvet
verifier.has_keybooleanEvet

Örnek yanıt:

{
  "bcc_address": "örnek",
  "validation": {
    "enabled": true,
    "check_mx": true,
    "block_disposable": true,
    "block_role": true
  },
  "verifier": {
    "provider": "zerobounce",
    "has_key": true
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

E-posta teslim ayarlarını güncelle (doğrulayıcı anahtarı zarf şifreli saklanır, geri okunmaz)

PUT/v1/apps/{appId}/email-deliverabilityDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: DeliverabilitySettingsDto

AlanTürZorunluAçıklama
bcc_addressstring (email) | nullHayır
validationobjectHayır
validation.enabledbooleanEvet
validation.check_mxbooleanHayır
validation.block_disposablebooleanHayır
validation.block_rolebooleanHayır
verifierobjectHayır
verifier.providerenum | nullEvet
verifier.api_keystringHayırUzunluk: 8–200

Örnek:

{
  "bcc_address": "ayse@example.com",
  "validation": {
    "enabled": true,
    "check_mx": true,
    "block_disposable": true,
    "block_role": true
  },
  "verifier": {
    "provider": "zerobounce",
    "api_key": "örnek"
  }
}

Yanıtlar

200 — Başarılı.

Şema: EmailDeliverabilitySettings

AlanTürZorunluAçıklama
bcc_addressstring | nullEvet
validationobjectEvet
validation.enabledbooleanEvet
validation.check_mxbooleanEvet
validation.block_disposablebooleanEvet
validation.block_rolebooleanEvet
verifierobjectEvet
verifier.providerenum | nullEvet
verifier.has_keybooleanEvet

Örnek yanıt:

{
  "bcc_address": "örnek",
  "validation": {
    "enabled": true,
    "check_mx": true,
    "block_disposable": true,
    "block_role": true
  },
  "verifier": {
    "provider": "zerobounce",
    "has_key": true
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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@example.com",
  "validation": {
    "enabled": true,
    "check_mx": true,
    "block_disposable": true,
    "block_role": true
  },
  "verifier": {
    "provider": "zerobounce",
    "api_key": "örnek"
  }
}'

Adres doğrulama testi (sözdizimi, MX, tek kullanımlık alan adı, rol hesabı, üçüncü taraf)

POST/v1/apps/{appId}/email-deliverability/verify-addressDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: VerifyAddressDto

AlanTürZorunluAçıklama
addressstringEvetUzunluk: 3–320

Örnek:

{
  "address": "örnek"
}

Yanıtlar

200 — Başarılı.

Şema: EmailAddressCheck

AlanTürZorunluAçıklama
okbooleanEvet
reasonenum | nullEvet
detailstring | nullEvet
checksarray<string>Evet
unknownarray<string>Evet

Örnek yanıt:

{
  "ok": true,
  "reason": "syntax",
  "detail": "örnek",
  "checks": [
    "örnek"
  ],
  "unknown": [
    "örnek"
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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"
}'

Isındırma planları (bugünkü limit/kullanım ve ileri günlere ayrılmış gönderimler)

GET/v1/apps/{appId}/email-deliverability/warmup-plansDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: EmailWarmupPlanList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].kindenumEvetDeğerler: "domain", "ip"
data[].targetstringEvet
data[].start_datestringEvet
data[].daily_limitsarray<integer>Evet
data[].provider_sharesmap<string, number>Evet
data[].timezonestringEvet
data[].statusenumEvetDeğerler: "active", "paused", "completed"
data[].todayobjectEvet
data[].today.daystringEvet
data[].today.indexintegerEvet
data[].today.limitinteger | nullEvet
data[].today.usedintegerEvet
data[].today.bucketsmap<string, object>Evet
data[].scheduled_aheadintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Örnek yanıt:

{
  "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"
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability/warmup-plans" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Isındırma planı oluştur (günlük limit eğrisi veya başlangıç/çarpan/hedef; sağlayıcı payları)

POST/v1/apps/{appId}/email-deliverability/warmup-plansDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: CreateWarmupPlanDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 1–100
kindenumEvetDeğerler: "domain", "ip"
targetstringEvetUzunluk: 2–253
start_datestringHayır
daily_limitsarray<integer>HayırÖğe: 1–120
curveobjectHayır
curve.startintegerEvetAralık: 1–1000000
curve.growthnumberEvetAralık: 1.05–3
curve.targetintegerEvetAralık: 1–10000000
provider_sharesobjectHayır
provider_shares.gmailnumberEvetAralık: 0–1
provider_shares.outlooknumberEvetAralık: 0–1
provider_shares.yahoonumberEvetAralık: 0–1
provider_shares.othernumberEvetAralık: 0–1
timezonestringHayırUzunluk: 1–64

Örnek:

{
  "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"
}

Yanıtlar

201 — Başarılı.

Şema: EmailWarmupPlan

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
kindenumEvetDeğerler: "domain", "ip"
targetstringEvet
start_datestringEvet
daily_limitsarray<integer>Evet
provider_sharesmap<string, number>Evet
timezonestringEvet
statusenumEvetDeğerler: "active", "paused", "completed"
todayobjectEvet
today.daystringEvet
today.indexintegerEvet
today.limitinteger | nullEvet
today.usedintegerEvet
today.bucketsmap<string, object>Evet
scheduled_aheadintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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"
}'

Isındırma planı

GET/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
planIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: EmailWarmupPlan

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
kindenumEvetDeğerler: "domain", "ip"
targetstringEvet
start_datestringEvet
daily_limitsarray<integer>Evet
provider_sharesmap<string, number>Evet
timezonestringEvet
statusenumEvetDeğerler: "active", "paused", "completed"
todayobjectEvet
today.daystringEvet
today.indexintegerEvet
today.limitinteger | nullEvet
today.usedintegerEvet
today.bucketsmap<string, object>Evet
scheduled_aheadintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Isındırma planını güncelle (duraklat/sürdür, eğri, paylar)

PATCH/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
planIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: UpdateWarmupPlanDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 1–100
statusenumHayırDeğerler: "active", "paused"
daily_limitsarray<integer>HayırÖğe: 1–120
provider_sharesobject | nullHayır

Örnek:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "daily_limits": [
    1
  ],
  "provider_shares": {
    "gmail": 1.5,
    "outlook": 1.5,
    "yahoo": 1.5,
    "other": 1.5
  }
}

Yanıtlar

200 — Başarılı.

Şema: EmailWarmupPlan

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
kindenumEvetDeğerler: "domain", "ip"
targetstringEvet
start_datestringEvet
daily_limitsarray<integer>Evet
provider_sharesmap<string, number>Evet
timezonestringEvet
statusenumEvetDeğerler: "active", "paused", "completed"
todayobjectEvet
today.daystringEvet
today.indexintegerEvet
today.limitinteger | nullEvet
today.usedintegerEvet
today.bucketsmap<string, object>Evet
scheduled_aheadintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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
  }
}'

Isındırma planını sil

DELETE/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
planIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: Ok

AlanTürZorunluAçıklama
oktrueEvet

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Isındırma planı gün × sağlayıcı kullanımı

GET/v1/apps/{appId}/email-deliverability/warmup-plans/{planId}/usageDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
planIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
dayssorguintegerHayırAralık: 1–1201
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: EmailWarmupUsage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].daystringEvet
data[].bucketstringEvet
data[].usedintegerEvet
data[].limitinteger | nullEvet

Örnek yanıt:

{
  "data": [
    {
      "day": "örnek",
      "bucket": "örnek",
      "used": 1,
      "limit": 50
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-deliverability/warmup-plans/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/usage" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Bu sayfada