Suppression list

E-posta/SMS gönderim engeli listesi (bounce, şikâyet, STOP, elle); ekleme, listeleme ve kaldırma.

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

İşlemlerBağlantıyı kopyala

AyrıntılarBağlantıyı kopyala

Suppression list (e-posta/SMS gönderilmeyecek adresler; kanal/neden/değer filtresi)Bağlantıyı kopyala

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

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: SuppressionPage

Örnek yanıt:

{
  "data": [
    {
      "channel": "email",
      "id": "sup_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "value_masked": "örnek",
      "reason": "bounce",
      "source": "örnek",
      "detail": {
        "key": "örnek"
      },
      "expires_at": "örnek",
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": 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/suppressions?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Adres ekle (manuel engel; değer saklanmaz, özet + maskeli gösterim)Bağlantıyı kopyala

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

Parametreler

İstek gövdesi (zorunlu)

Şema: CreateSuppressionDto

Örnek:

{
  "channel": "email",
  "value": "user_42",
  "reason": "manual",
  "expires_at": "2026-10-17T09:00:00Z",
  "note": "örnek"
}

Yanıtlar

201 — Başarılı.Bağlantıyı kopyala

Şema: Suppression

Örnek yanıt:

{
  "channel": "email",
  "id": "sup_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "value_masked": "örnek",
  "reason": "bounce",
  "source": "örnek",
  "detail": {
    "key": "örnek"
  },
  "expires_at": "örnek",
  "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/suppressions" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "email",
  "value": "user_42",
  "reason": "manual",
  "expires_at": "2026-10-17T09:00:00Z",
  "note": "örnek"
}'

Kaydı kaldır (adres yeniden gönderim alabilir)Bağlantıyı kopyala

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

Parametreler

Yanıtlar

200 — Başarılı.Bağlantıyı kopyala

Şema: Ok

Ö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/suppressions/sup_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"