Yeni E-posta Paylaşımı Oluşturma

Yeni bir e-posta paylaşımı oluşturur.

POST /v1/email_campaigns/{campaign_id}/email_sharings

Kimlik Doğrulama

Kimlik Doğrulama Yöntemi Token token=<API_TOKEN>

İstek

Yol Parametreleri

Parametre	Tip	Zorunlu	Açıklama	Örnek
`campaign_id`	string (uuid)	Evet	Kampanya ID'si.	`campaign_id`

Header Bilgileri

Header	Zorunlu	Açıklama	Örnek
`Content-Type`	Evet	İstek içeriğinin türü.	`application/json`
`Authorization`	Evet	Pisano API anahtarı.	`Token token=<API_TOKEN>`

İstek Gövdesi

{
  "emails": [
    "<email>"
  ],
  "custom_attributes": {
    "<recipient>": {
      "name": "<name>",
      "external_id": "<external_id>",
      "phone_number": "<phone_number>"
    }
  },
  "built_in_responses": {
    "<email>": {
      "customerDetailInfo1": "<customerDetailInfo1>",
      "customerDetailInfo2": "<customerDetailInfo2>"
    }
  }
}

İstek Gövdesi Alanları

Alan	Tip	Zorunlu	Açıklama
`emails`	array		E-posta adresleri.
`emails[]`	string		E-posta adresi.
`custom_attributes`	object	Hayır	Özel nitelikler.
`custom_attributes.<recipient>.name`	string		Müşterinin adı.
`custom_attributes.<recipient>.external_id`	string		Müşterinin harici tanımlayıcısı.
`custom_attributes.<recipient>.phone_number`	string		Müşterinin telefon numarası.
`built_in_responses` / `transactional_data`	object	Hayır	Her alıcıyla ilişkili yerleşik yanıt verileri. `transactional_data`, API tarafından desteklenen alternatif bir alan adıdır.

İstek Örneği

cURL

cURL İstek Örneği

curl --location 'https://<pisanoEnvironment>/v1/email_campaigns/<campaignID>/email_sharings' \
--header 'Authorization: Token token=<API_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
  "emails": [
    "<email>"
  ],
  "custom_attributes": {
    "<recipient>": {
      "name": "<name>",
      "external_id": "<external_id>",
      "phone_number": "<phone_number>"
    }
  },
  "built_in_responses": {
    "<email>": {
      "customerDetailInfo1": "<customerDetailInfo1>",
      "customerDetailInfo2": "<customerDetailInfo2>"
    }
  }
}'

Yanıtlar

200 Başarılı

Yanıt Alanları

Alan	Tip	Açıklama
`status`	string	E-posta paylaşımı isteği için döndürülen işlem durumu.
`delivery_time`	string	İstek için döndürülen gönderim zamanı.
`sidekiq_job_id`	string	Arka plan görevinin tanımlayıcısı.
`correlation_id`	string	İsteği izlemek ve ilişkili işlemlerle eşleştirmek için kullanılan tanımlayıcı.

Yanıt Örneği

JSON Yanıt Örneği

{
  "status": "enqueued",
  "delivery_time": "<delivery_time>",
  "sidekiq_job_id": "<sidekiq_job_id>",
  "correlation_id": "<correlation_id>"
}

400 hatalı_istek

{
  "error_message": "string",
  "data": "string",
  "code": 0,
  "errors": [
    {
      "code": "string",
      "message": "string",
      "field": "string"
    }
  ]
}

401 Hata: Yetkisiz Erişim

Hata Kodu: 13001
Hata Mesajı: Hatalı kimlik doğrulama anahtarı

{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}

403 Hata: Erişim Yasak

Hata Kodu: 13013
Hata Mesajı: İzin reddedildi

{"error_message":"Permission denied","data":"Permission denied","code":13013,"errors":null}

404 İstenen kaynak bulunamadı!

İstenen kaynak bulunamadı!

Ek Bilgiler

İstek Sınırları

20 istek/5 sn; 40/25 sn; 80/125 sn; 160/625 sn. Şirket içi sunucu kurulumlarında kullanılan istek sınırı kuralları değiştirilebilir veya kaldırılabilir.

Kullanım Kısıtlamaları

En iyi uygulama olarak tek bir istekte en fazla 5.000 müşteriye gönderim yapılması önerilir.

Pisano Kampanya Paylaşım API'leri - Email - Email Paylaşımı