Şablonlar

API Reference

Şablonlar

Tekrar kullanılabilir mesaj şablonları, değişken alanlar ve template yönetimi.

Şablonlar kampanya ve tekli mesaj akışlarında tekrar kullanılabilir içerik üretir. {{ad}}, {{sehir}} gibi değişken alanlar içerikten otomatik çıkarılır.

Tekrar kullanım

Aynı şablon hem tekli mesajlarda hem kampanyalarda kullanılabilir.

Değişken çıkarımı

İçerik güncellendiğinde variables listesi yeniden hesaplanır.

Tenant izolasyonu

Her template yalnız owner kullanıcı tarafından okunur, güncellenir ve silinir.

POST/v1/templates
X-API-Key200 OK

Şablon oluştur

Yeni mesaj şablonu oluşturur ve içerikte geçen değişken alanları otomatik olarak çıkarır.

Zorunlu alanlarname, category ve content gereklidir.
Content typeVarsayılan kullanım text içeriktir. Şablon metni medya yüklemeden bağımsızdır.

Kategori ve dil alanları serbest string olarak saklanır; kendi entegrasyonunuzda bu alanlarla segmentasyon yapabilirsiniz.

İstek

curl --request POST \
--url {{BASE_URL}}/v1/templates \
--header "X-API-Key: {{API_KEY}}" \
--header "Content-Type: application/json" \
--data '{
  "name": "Sipariş Hazır",
  "category": "bildirim",
  "language": "tr",
  "content": "Merhaba {{ad}}, siparişiniz {{sube}} şubesinde hazır.",
  "content_type": "text"
}'

Yanıt

JSON
{
"data": {
  "id": "863d7e9e-17e5-469d-b44b-bf4158b22fd4",
  "name": "Sipariş Hazır",
  "category": "bildirim",
  "language": "tr",
  "content": "Merhaba {{ad}}, siparişiniz {{sube}} şubesinde hazır.",
  "content_type": "text",
  "variables": ["ad", "sube"],
  "is_active": true,
  "usage_count": 0
}
}
GET/v1/templates
X-API-Key200 OK

Şablonları listele

Kullanıcının tüm template kayıtlarını aktiflik ve kullanım sayısı ile listeler.

usage_count alanı template’in ne kadar kullanıldığını gösterir.

Liste görünümü kampanya ve mesaj formu için kullanılacak template seçim yüzeyini besler.

İstek

curl --request GET \
--url {{BASE_URL}}/v1/templates \
--header "X-API-Key: {{API_KEY}}"

Yanıt

JSON
{
"data": {
  "templates": [
    {
      "id": "863d7e9e-17e5-469d-b44b-bf4158b22fd4",
      "name": "Sipariş Hazır",
      "category": "bildirim",
      "language": "tr",
      "content": "Merhaba {{ad}}, siparişiniz {{sube}} şubesinde hazır.",
      "content_type": "text",
      "variables": ["ad", "sube"],
      "is_active": true,
      "usage_count": 42
    }
  ]
}
}
PUT/v1/templates/:template_id
X-API-Key200 OK

Şablonu güncelle

Template içeriğini, aktiflik durumunu veya metadata alanlarını günceller.

is_active: false yaparak template’i silmeden pasifleştirebilirsiniz.

İçerik değiştiğinde değişken listesi yeniden hesaplanır; eksilen değişkenler response’tan da düşer.

İstek

curl --request PUT \
--url {{BASE_URL}}/v1/templates/{{TEMPLATE_ID}} \
--header "X-API-Key: {{API_KEY}}" \
--header "Content-Type: application/json" \
--data '{
  "content": "Merhaba {{ad}}, siparişiniz mağazada hazır.",
  "is_active": true
}'

Yanıt

JSON
{
"data": {
  "id": "863d7e9e-17e5-469d-b44b-bf4158b22fd4",
  "name": "Sipariş Hazır",
  "content": "Merhaba {{ad}}, siparişiniz mağazada hazır.",
  "variables": ["ad"],
  "is_active": true
}
}

Diğer template uçları

MetotYolAmaç
GET/v1/templates/:template_idTek şablon detayını döner
DELETE/v1/templates/:template_idŞablonu kalıcı olarak siler