Şablonlar

Tekrar kullanılan mail içerikleri sunucuda şablon olarak saklanabilir. Oluşturma/güncelleme gövdesinde name, subject, html üçü de zorunludur (eksik 422 validation_error). PUT tam güncellemedir ve her başarılı çağrıda version 1 artar.

Liste

GET/public/v1/templatesscoperead

En yeni başta, sayfalı zarf (items/totalCount/page/pageSize).

Sorgu parametreleri

AdTipZorunluAçıklama
pageintegerhayırSayfa numarası, ≥ 1.
pageSizeintegerhayır1–100 (varsayılan 20).
searchstringhayırAd/konu içinde arar.

Oluştur

POST/public/v1/templatesscopesend

Gövde

AdTipZorunluAçıklama
namestringevetŞablon adı.
subjectstringevetKonu; {{degisken}} desteklenir.
htmlstringevetHTML gövde.

Tekil

GET/public/v1/templates/{id}scoperead

Path parametreleri

AdTipZorunluAçıklama
idstringevetŞablon id'si (tpl_…).

Tam güncelleme (Version +1)

PUT/public/v1/templates/{id}scopesend

PUT tam güncellemedir; üç alan da gönderilir ve her başarılı çağrıda version 1 artar.

Path parametreleri

AdTipZorunluAçıklama
idstringevetŞablon id'si (tpl_…).

Gövde

AdTipZorunluAçıklama
namestringevetŞablon adı.
subjectstringevetKonu; {{degisken}} desteklenir.
htmlstringevetHTML gövde.

Sil

DELETE/public/v1/templates/{id}scopesend

Başarıda 204 (gövdesiz).

Path parametreleri

AdTipZorunluAçıklama
idstringevetŞablon id'si (tpl_…).

Değişkenli önizleme

POST/public/v1/templates/{id}/render-previewscoperead

{{degisken}} değerlerini şablonun güncel subject/html'ine uygular; durum değiştirmez (bu yüzden read scope'u — HTTP fiili POST olsa da).

Path parametreleri

AdTipZorunluAçıklama
idstringevetŞablon id'si (tpl_…).

Gövde

AdTipZorunluAçıklama
variablesobjecthayırBoş/verilmemişse yer tutucular olduğu gibi görünür (render edilmemiş önizleme).

Test gönderimi (kredi yok)

POST/public/v1/templates/{id}/send-testscopesend

Path parametreleri

AdTipZorunluAçıklama
idstringevetŞablon id'si (tpl_…).

Gövde

AdTipZorunluAçıklama
identityIdstringevetGönderen kimlik id'si (id'ler kimlik CRUD yanıtlarından gelir; messages/test'in from adres çözümünden bilinçli farklı, panel paritesi).
recipientstringevetTest alıcısı.
  • Kredi düşmez; bastırma/MX kontrolü uygulanmaz. Şablon değişkensiz (yer tutucular görünür halde) gönderilir.
  • Şablon veya kimlik bulunamadıysa 404 not_found; kimlik doğrulanmamışsa 422 identity_not_verified; sağlayıcı hatasında 502 send_failed.

POST /messages şablon id'siyle gönderim almaz (v1'de templateId alanı yok); şablon içeriğini GET /templates/{id} veya render-preview ile alıp mesaj gövdesine koyarsınız.