Ş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/templatesscopereadEn yeni başta, sayfalı zarf (items/totalCount/page/pageSize).
Sorgu parametreleri
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
page | integer | hayır | Sayfa numarası, ≥ 1. |
pageSize | integer | hayır | 1–100 (varsayılan 20). |
search | string | hayır | Ad/konu içinde arar. |
Oluştur
POST
/public/v1/templatesscopesendGövde
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | Şablon adı. |
subject | string | evet | Konu; {{degisken}} desteklenir. |
html | string | evet | HTML gövde. |
Tekil
GET
/public/v1/templates/{id}scopereadPath parametreleri
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
id | string | evet | Şablon id'si (tpl_…). |
Tam güncelleme (Version +1)
PUT
/public/v1/templates/{id}scopesendPUT tam güncellemedir; üç alan da gönderilir ve her başarılı çağrıda version 1 artar.
Path parametreleri
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
id | string | evet | Şablon id'si (tpl_…). |
Gövde
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | Şablon adı. |
subject | string | evet | Konu; {{degisken}} desteklenir. |
html | string | evet | HTML gövde. |
Sil
DELETE
/public/v1/templates/{id}scopesendBaşarıda 204 (gövdesiz).
Path parametreleri
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
id | string | evet | Ş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
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
id | string | evet | Şablon id'si (tpl_…). |
Gövde
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
variables | object | hayır | Boş/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-testscopesendPath parametreleri
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
id | string | evet | Şablon id'si (tpl_…). |
Gövde
| Ad | Tip | Zorunlu | Açıklama |
|---|---|---|---|
identityId | string | evet | Gö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). |
recipient | string | evet | Test 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 422identity_not_verified; sağlayıcı hatasında 502send_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.