Campaign Service

Owned by Melih Ayhan (Unlicensed)
Last updated: Dec 26, 2022 by Berk Topaloğlu
13 min read

Dakikada gönderilebilecek en fazla istek sayısı 1000'dir.

MetodAçıklama
AppendListToCampaign
Spesifik bir kampanyaya liste ekler. (MSCRM entegrasyonu için).
CancelEmailCampaign
Gönderimi henüz tamamlanmamış bir kampanyayı iptal etmeyi sağlar.
CreateEmailCampaign
Bir e-posta kampanyası oluşturmak için kullanılır.
CreatePushCampaignBir Push kampanyası oluşturur veya varolan bir push kampanyasını günceller.
CreateWebPushCampaignBir Web Push kampanyası oluşturur veya varolan bir web push kampanyasını günceller.
CreateSmsCampaign
Bir SMS kampanya oluşturmayı sağlar.
LockCampaign
Gönderime hazır olan bir kampanyayı duraklatır.
QueryEmailCampaign
Mevcut bir kampanyanın parametrelerini listeler.
QuerySmsCampaign
Varolan bir SMS Kampanyasının parametrelerini listeler.
SelectCanceledEmailCampaigns
Belli bir tarih aralığında iptal edilen kampanyaları listeler.
QueryMemberCampaignsMemberID'ye göre kampanya durumunu özetler.
SelectCreatedEmailCampaigns
Belirli bir gün aralığındaki kampanyaları seçmek için kullanılır.
SelectOngoingEmailCampaigns
Belli bir tarih aralığında oluşturulmuş işlem kampanyalarını listeler.
SelectScheduledEmailCampaigns
Belirli bir gün aralığında zamanlanmış email kampanyaları ve durumlarını seçer.
SelectTestedEmailCampaigns
Belli bir tarih aralığında test gönderimi yapılmış kampanyaları listeler.
SendEmailCampaign
Bir e-posta kampanyası göndermek için kullanılır.
SendPushCampaignBir Push kampanyası göndermek için kullanılır.
SendEmailCampaignWithExtendedOptions
Harici seçeneklerle birlikte email kampanyası gönderimi için kullanılır.
SendSmsCampaignBir SMS kampanyası göndermek için kullanılır.
StartEmailCampaign
Gönderimi durdurulmuş bir e-posta kampanyasını yeniden başlatır.
StopEmailCampaign
Gönderimde olan email kampanyasını duraklatmak için kullanılır.
TestEmailCampaignBir email kampanyasının test gönderimini sağlar.
TestSmsCampaignBir sms kampanyasının test gönderimini sağlar.
UnlockCampaign
Gönderime hazır kampanyaları aktif duruma getirir.
UpdateEmailCampaign
Taslak olarak yer alan bir e-posta kampanyasını güncellemek için kullanılır.
UpdateSmsCampaign
SMS kampanyasını günceller. Eğer kampanya yok ise yeni bir kampanya oluşturur.
CancelSmsCampaignGönderimde olan bir SMS kampanyasını iptal eder.
CancelPushCampaignGönderimde olan bir Push kampanyasını iptal eder.
StopPushCampaignGönderimde olan Push kampanyasını duraklatmak için kullanılır.
StartPushCampaignÖnceden durdurulmuş bir Push kampanyasını tekrardan gönderime başlatır.
CancelWebPushCampaignGönderimde olan bir Web Push kampanyasını iptal eder.
StopWebPushCampaignGönderimde olan Web Push kampanyasını duraklatmak için kullanılır.
StartWebPushCampaignÖnceden durdurulmuş bir Web Push kampanyasını tekrardan gönderime başlatır.

CreateEmailCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CreateEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CreateEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreateEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CreateEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

 Name(string): Maks. 100 karakterlik kampanya adı,

 Subject(string []): Konu dizisi. Optimizasyon için, en fazla 3 konu sağlayın.,

 CampaignId(string): 32byte guid.

 FromName(string): Hesabınızda tanımlanmış geçerli bir gönderici ismi,

 CampaignType(int): 1: SingleShot(Auto:N), 2: Template(Auto:O), 3: Automatic(Auto:Y)

Single Shot: Bir kampanya, bırak ve gönder

Template: Online kampanya. bırak & kaydet ve tetikle.

Automatic: Periyodik kampanyalar. Ayrıntılar için lütfen hesap yöneticilerine danışınız.

 FromAddress(string): hesabınızda tanımlanmış geçerli bir gönderici adresi,

 ReplyAddress(string): cevap e-postası, geçerli bir email adresi.

 HtmlMessage(string): kampanyanın html içeriği,

 PreHeaderText(string): kampanyanın ön metni,

 Locked(bool): Opsiyonel parametre.,

 ReadFlag(bool): Opsiyonel parametre.,

 ClickThroughFlag(bool): Opsiyonel parametre.,

 ShareThisFlag(bool): Opsiyonel parametre.,

 UniqueEmailFlag(bool): Opsiyonel parametre.. Make target list e-mail unique,

 RateFlag(bool): Opsiyonel parametre. Oylama değerlendirmesi,

 OmnitureFlag(bool): Opsiyonel parametre.,

 GoogleAnalytics(bool): Opsiyonel parametre.,

 GoogleUtmSource(string): Opsiyonel parametre.,

 GoogleUtmMedium(string): Opsiyonel parametre.,

 GoogleUtmTerm(string): Opsiyonel parametre.,

 GoogleUtmContent(string): Opsiyonel parametre.,

 GoogleUtmCampaign(string): Opsiyonel parametre.,

 Speed(int): Opsiyonel parametre.(1-5 arasında olmalı),

 ExpireDate(string): Opsiyonel parametre.. (Kampanya bitiş tarihi)

 FL_ID(string): Opsiyonel parametre. (Kampanyada hedeflenen veri ambarı tablosuna ait ID değeri. Örnek: "1234567890123456789011231313132")

9:Sample Body

 {

  "Name": "",

  "Subject": ["",""],

  "CampaignId": "",

  "FromName" :" ",

  "CampaignType":"",

  "FromAddress":"",

  "ReplyAddress":"",

  "HtmlMessage":"",

  "PreHeaderText":"",

   “Locked” :false,

   “ReadFlag”:false,

   “ClickThroughFlag”:false,

   “ShareThisFlag”:false,

   “UniqueEmailFlag”:false,

   “RateFlag”:false,

   “OmnitureFlag”:false,

   “GoogleAnalytics”:false,

   “GoogleUtmSource”:””,

   “GoogleUtmMedium“:””,

   “GoogleUtmTerm”:””,

   “GoogleUtmContent”:””,

   “GoogleUtmCampaign”:””,

  “Speed”:1,

 “ExpireDate”:””,

 "FL_ID": ""

}

Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 

CreatePushCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CreatePushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CreatePushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreatePushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CreatePushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

 Name(string): Maks. 100 karakterlik kampanya adı,

 CampaignId(string): 32byte guid ,

 Type(int):Görüntü - 1,Video - 2,Metin -3 , Ayarlar - 4, Anket -5

 TextMessage(string): Kampanya içeriği

 AlternateTextMessage(string): A/B Test alternatif mesaj içeriği,

 TargetUrl(string): Kampanya hedef url

 AlternateTargetUrl(string): A/B Test alternatif hedef url

 MediaUrl(string): Opsiyonel parametre.,

 AlternateMediaUrl(string): Opsiyonel parametre.,

 CustomParams(string): Opsiyonel parametre.,

 AlternateCustomParams(string): Opsiyonel parametre,

 ReportAdmins(string): Opsiyonel parametre. ,

 FastListId(string): Dosya ID'si,

 SpeedLimitation(int): Opsiyonel parametre.,

 DailyLimit(int): Opsiyonel parametre.,

 AbCustomization(string): Opsiyonel parametre. AB test için Y (Evet), N(Hayır)

 DeliveryDate(string): Kampanya ulaşma zamanı

DeliveryExpireDate(string): Kampanya bitiş zamanı

Application(Aplication):

{

Name(string): Uygulama adı.

Type(string): Uygulama türü I = iOS A = Android

}


Sample Body

{

"CampaignId": string,

"Name": string,

"Type": string,

"TextMessage": string,

"AlternateTextMessage": string,

"TargetUrl": string,

"AlternateTargetUrl": string,

"MediaUrl": "",

"AlternateMediaUrl": "",

"CustomParams": "",

"AlternateCustomParams": "",

"ReportAdmins": "false",

"DeliveryDate": "2030-01-01 00:00:00",

"DeliveryExpireDate": "2030-01-01 20:00",

"ReportExpireDate": "2030-01-01 20:00",

"SpeedLimitation": 16,

"DailyLimit": 17,

"AbCustomization": "",

"Application":

{ "Name": "Test2018", "Type": "A" },

"Classification1":

{ "ClassificationLabel": "", "ClassificationValue": "" },

"IsBadge": true,

"IsMutableContent": false }


Sample Response

{

"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null

}


Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


CreateWebPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CreateWebPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CreateWebPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreateWebPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CreateWebPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

 Name(string): Maks. 100 karakterlik kampanya adı.,

 CampaignId(string): 32byte guid.,

 Type(int):Görüntü - 1,Video - 2,Metin -3 , Ayarlar - 4, Anket -5.,

 TextMessage(string): Kampanya içeriği.,

 AlternateTextMessage(string): A/B Test alternatif mesaj içeriği.,

 TargetUrl(string): Kampanya hedef url.,

 AlternateTargetUrl(string): A/B Test alternatif hedef url

 MediaUrl(string): Opsiyonel parametre.,

 AlternateMediaUrl(string): Opsiyonel parametre.,

 CustomParams(string): Opsiyonel parametre.,

 AlternateCustomParams(string): Opsiyonel parametre,

 ReportAdmins(string): Opsiyonel parametre. ,

 FastListId(string): Dosya ID'si,

 SpeedLimitation(int): Opsiyonel parametre.,

 DailyLimit(int): Opsiyonel parametre.,

 AbCustomization(string): Opsiyonel parametre. AB test için Y (Evet), N(Hayır)

 DeliveryDate(string): Kampanya ulaşma zamanı

DeliveryExpireDate(string): Kampanya bitiş zamanı

Application(Aplication):


Sample Body

{
"CampaignId": "",

"Name": "",

"Type": "1",

"TextMessage": "",

"AlternateTextMessage": "",

"TargetUrl": "",

"ReportAdmins": "",

"DeliveryDate": "YYYY-DD-MM HH:MM:SS",

"DeliveryExpireDate": "YYYY-DD-MM HH:MM",

"ReportExpireDate": "YYYY-DD-MM HH:MM",

"IsMutableContent": true,

"Applications": "",

"MultipleApplications": [

{
"Name": "WebPushAppName",

"Type": "W"

}

]

}


Sample Response

{
"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 

CreateSmsCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CreateSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CreateSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CreateSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CreateSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignID: ID for the new Sms campaign.,

Name: Campaign name.,

Campaign Type: SingleShot or Template or Automatic.,

Originator: SMS Campaing Sender's Name.,

SmsMessage: Message Text.,

AlternateSmsMessage: Alternate Message Text.,

Service Ticket: Service Ticket obtained through Login.,

UniqueSmsFlag: If this parameter is true, the repeated GSM numbers in the selected audience are

de-duplicated at the same of sending.

Sample Body

{

"CampaignId": "7B642FC9C92049E78EB53CD37C78FB61",

"Name": "Rest Api CreateSmsCampaign",

"CampaignType": "SingleShot",

"Originator": "HEDEF MEDYA",

"Locked": false,

"SmsMessage": "Rest Api CreatePushCampaign",

"AlternateSmsMessage": "",

"UniqueSmsFlag": true,

"Created": "2018-09-27 15:50",

"Updated": "2018-09-27 15:59",

"DeliveryStartDate": "2018-09-27 17:00",

"Status": "A"
}

Sample Response

{

"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null

}


Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


SendEmailCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/SendEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/SendEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/SendEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/SendEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): E-mail kampanya id'si,

DeliveryDateTime(string): format: yyyy-AA-gg SS:dd,

FilterType(int): Gönderim kitlesi için hangi filtre kullanılacak. 1 : Demographic, 2 : DataWarehouse,

Filters(Filter[]): Key, value operatörlerini içeren filtreleme dizisi.

{

Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır.

Value(string):Key kolonu için değer,

Operator(int): LessThan = 1, LessOrEqualThan = 2, GreaterThan = 3,GreaterOrEqualThan = 4,

        Equal = 5, NotEqual = 6, Like = 7, NotLike = 8

}

DataWarehouseTableName(string): Data Warehouse tablo adı,

AdminReportTo(string): Kampanya başlangıç ve bitiş raporlarının kime bildirileceği ,

ReportLanguage: Rapor dili.(Turkish = 1,English = 2),

Lists(SendList []): Gönderim listesi dizisi.

{

  GroupName(string): Listenin bağlı olduğu grup adı,

  ListName(string): Grup adı altındaki liste adı.

}

ReportInformationList(SchedulingCampaignReport[]): Rapor .

{

Hour(short): Rapor gönderim zamanı.

ReceiverEmails(string[]): Alıcı email listesi.

},

SubjectOptimization(SubjectOptimization):

{

Target(short): Hedef yüzdesi. CreateEmailCampaign'de birden fazla konu vererek subject optimizasyonunu etkinleştirirseniz %10'u kullanın.

WaitInHour(short): Hedef yüzdesine gönderim yapıldıktan sonra hangi konunun daha iyi olduğuna karar vermek için beklenmesi gereken süre. 1 saat kullanılması tavsiye edilir

}

Sample Body

{
  "CampaignId": "",
  "DeliveryDateTime" :"",
  "FilterType":"1",
  "Filter": {
    "Type": "",
    "Items": [
      {
        "Key": "",
        "Value": "",
        "Operator": ""
      }
    ]
  },
  "DataWarehouseTableName":"",
  "ReportInformationList":[{"Hour":1, "ReceiverEmails":[] },{"Hour":6, "ReceiverEmails":[] }],
  "ReportLanguage":1,
  "AdminReportTo":""
}

Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,14,36,37,38,67,74,76,80,127,135

SendPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/SendPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/SendPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/SendPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/SendPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): E-mail kampanya id'si,

DeliveryDateTime(string): format: yyyy-AA-gg SS:dd,

Filter(Filter): .

{

Type(int): Gönderim kitlesi için hangi filtre kullanılacak. 1 : Demographic, 2 : DataWarehouse,

Items:[

Key (string): Bu alanda hesap özelinde tanımlanan birincil anahtar sütunu (EMAIL, KEY_ID) yer almalıdır.

Value(string): Key kolonu için değer,

Operator(int): LessThan = 1, LessOrEqualThan = 2, GreaterThan = 3,GreaterOrEqualThan = 4,

        Equal = 5, NotEqual = 6, Like = 7, NotLike = 8

}],

DataWarehouseTableName(string): Data Warehouse tablo adı,

AdminReportTo(string): Kampanya başlangıç ve bitiş raporlarının kime bildirileceği ,

ReportLanguage: Rapor dili (Türkçe = 1,English = 2),

Lists(SendList []): Gönderim listesi dizisi.

{

  GroupName(string): Liste'nin bağlı olduğu grup adı,

  ListName(string): Grup adı altındaki liste adı.

}

ReportInformationList(SchedulingCampaignReport[]): Marketing pdf report parameter.

{

Hour(short): When will the report be sent.

ReceiverEmails(string[]): receiver email list.

}

Sample Body

{
"CampaignId": "",
"DeliveryDateTime": "",
"DataWarehouseTableName": "",
"Filter": {
"Type": ,
"Items": [
{
"Key": "",
"Value": "",
"Operator":
}
]
},
"Lists": [
{
"GroupName": "",
"ListName": ""
}
],
"ReportInformationList": [
{
"Hour": ,
"ReceiverEmails": [
""
]
}
],
"ReportLanguage": ,
"AdminReportTo": ""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,14,36,37,38,67,74,76,80,127,135

NoteYou can use the list or filter to send
Filter and List can not be used at the same time.


SendSmsCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/SendSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/SendSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/SendSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/SendSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan ticket değeri

Body

CampaignID: Service Ticket obtained through Login

GroupName: GroupName

ListName: ListName

ServiceTicket: ServiceTicket obtained through Login

DeliveryStartDateTime: Campaign is start date

DeliveryEndDateTime: Campaign is finish date

MarketingPDFLanguage: Language selection for PDF reports

AdminReportTo:Email address to send administrative campaign reports to

Sample Body


{
"CampaignId": "7B642FC9C92049E78EB53CD37C78FB61",
"DeliveryStartDateTime": "2018-09-27 17:00",
"DeliveryEndDateTime": "2018-09-27 21:00",
"Filter": {
"Type": 1,
"Items": [
{
"Key": "Cep_Telefonunuz",
"Value": "538.0357261",
"Operator": 5
}
]
},

"ReportInformationList": [
{
"Hour": 1,
"ReceiverEmails": [
"ogun.ozturk@relateddigital.com"
]
},
{
"Hour": 2,
"ReceiverEmails": [
"ogun.ozturk@relateddigital.com"
]
}
],
"MarketingPDFLanguage": "Turkish",
"AdminReportTo": "ogun.ozturk@relateddigital.com"
}

Sample Response

{
   "Success": true,
   "Errors": [],
   "DetailedMessage": "",
   "TransactionId": "D3285862D6EE4E4A81DE23ACCB912824"
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,14,36,37,38,67,74,76,80,127,135

NoteYou can use the list or filter to send
Filter and List can not be used at the same time.

CancelEmailCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CancelEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CancelEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CancelEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CancelEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın. ,

ForceCancelIfCampStarted(boolean): True değer verilmesi durumunda, gönderimi başlamış kampanyayı iptal eder(Force Cancel). ,


Sample Body


{
"CampaignId":"",
"ForceCancelIfCampStarted":false
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 




StopEmailCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/StopEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/StopEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/StopEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/StopEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın.


Sample Body


{
"CampaignId":""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



StartEmailCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/StartEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/StartEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/StartEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/StartEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın.


Sample Body


{
"CampaignId":""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



CancelSmsCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CancelSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CancelSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CancelSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CancelSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın. ,

ForceCancelIfCampStarted(boolean): True değer verilmesi durumunda, gönderimi başlamış kampanyayı iptal eder(Force Cancel).,


Sample Body


{
"CampaignId":"",
"ForceCancelIfCampStarted":false
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



CancelPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CancelPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CancelPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CancelPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CancelPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın. ,

ForceCancelIfCampStarted(boolean): True değer verilmesi durumunda, gönderimi başlamış kampanyayı iptal eder(Force Cancel). ,


Sample Body


{
"CampaignId":"",
"ForceCancelIfCampStarted":false
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



StopPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/StopPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/StopPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/StopPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/StopPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın.


Sample Body


{
"CampaignId":""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



StartPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/StartPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/StartPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/StartPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/StartPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın.


Sample Body


{
"CampaignId":""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



CancelWebPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/CancelWebPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/CancelWebPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/CancelWebPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/CancelWebPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın. ,

ForceCancelIfCampStarted(boolean): True değer verilmesi durumunda, gönderimi başlamış kampanyayı iptal eder(Force Cancel).,

Sample Body


{
"CampaignId":"",
"ForceCancelIfCampStarted":false
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



StopWebPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/StopWebPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/StopWebPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/StopWebPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/StopWebPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın.


Sample Body


{
"CampaignId":""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



StartWebPushCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/campaign/StartWebPushCampaign

ECOMM: https://api.relateddigital.com/reste/api/campaign/StartWebPushCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/campaign/StartWebPushCampaign

LIVEM: https://api.relateddigital.com/restm/api/campaign/StartWebPushCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

CampaignId(string): 32 byte guid değer sağlayın.


Sample Body


{
"CampaignId":""
}


Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


AppendListToCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/AppendListToCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/AppendListToCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/AppendListToCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/AppendListToCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "ListGroup": "sample string 2",

  "ListName": "sample string 3"

}

Sample Response

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""
    }

  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


CreateOffer  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/CreateOffer 

ECOMM: https://api.relateddigital.com/reste/api/Campaign/CreateOffer

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/CreateOffer

LIVEM: https://api.relateddigital.com/restm/api/Campaign/CreateOffer

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body

OfferID: integer

OfferHtml: string

ExpireDate: string

Sample Body

{

  "OfferID": 1,

  "OfferHtml": "sample string 2",

  "ExpireDate": "sample string 3"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""
"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


CreateSmsCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/CreateSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/CreateSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/CreateSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/CreateSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "Name": "sample string 2",

  "CampaignType": "SingleShot",

  "Originator": "sample string 3",

  "Locked": true,

  "SmsMessage": "sample string 5",

  "AlternateSmsMessage": "sample string 6",

  "UniqueSmsFlag": true,

  "Created": "sample string 8",

  "Updated": "sample string 9",

  "DeliveryStartDate": "sample string 10",

  "Status": "sample string 11"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


DeleteOffer  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/DeleteOffer

ECOMM: https://api.relateddigital.com/reste/api/Campaign/DeleteOffer

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/DeleteOffer

LIVEM: https://api.relateddigital.com/restm/api/Campaign/DeleteOffer

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "OfferID": 1

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""
"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


GetOffer  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/GetOffer 

ECOMM: https://api.relateddigital.com/reste/api/Campaign/GetOffer

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/GetOffer

LIVEM: https://api.relateddigital.com/restm/api/Campaign/GetOffer

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "OfferID": 1

}

Sample Response

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


LockCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/LockCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/LockCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/LockCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/LockCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1"

}

Sample Response

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


QueryEmailCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/QueryEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/QueryEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/QueryEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/QueryEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1"

}

Sample Response

{

"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


QueryMemberCampaigns 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/QueryMemberCampaigns

ECOMM: https://api.relateddigital.com/reste/api/Campaign/QueryMemberCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/QueryMemberCampaigns

LIVEM: https://api.relateddigital.com/restm/api/Campaign/QueryMemberCampaigns

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "MemberId": "sample string 1",

  "CampaignIds": [

    "sample string 1",

    "sample string 2"

  ]

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""
"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



QuerySmsCampaign  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/QuerySmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/QuerySmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/QuerySmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/QuerySmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1"

}

Sample Response

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


SelectCanceledEmailCampaigns  

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SelectCanceledEmailCampaigns

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SelectCanceledEmailCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SelectCanceledEmailCampaigns

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SelectCanceledEmailCampaigns

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "SinceDayAgo": 1

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


SelectCreatedEmailCampaigns 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SelectCreatedEmailCampaigns

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SelectCreatedEmailCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SelectCreatedEmailCampaigns

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SelectCreatedEmailCampaigns

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "SinceDayAgo": 1

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



SelectOngoingEmailCampaigns 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SelectOngoingEmailCampaigns

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SelectOngoingEmailCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SelectOngoingEmailCampaigns

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SelectOngoingEmailCampaigns

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "SinceDayAgo": 1

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""
"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


SelectScheduledEmailCampaigns 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SelectScheduledEmailCampaigns

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SelectScheduledEmailCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SelectScheduledEmailCampaigns

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SelectScheduledEmailCampaigns

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "SinceDayAgo": 1

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


SelectTestedEmailCampaigns 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SelectTestedEmailCampaigns

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SelectTestedEmailCampaigns

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SelectTestedEmailCampaigns

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SelectTestedEmailCampaigns

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "SinceDayAgo": 1

}

Sample Response

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


SendEmailCampaignWithExtendedOptions 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SendEmailCampaignWithExtendedOptions

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SendEmailCampaignWithExtendedOptions

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SendEmailCampaignWithExtendedOptions

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SendEmailCampaignWithExtendedOptions

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "DeliveryDateTime": "sample string 2",

  "Filter": {

    "Type": "Demographic",

    "Items": [

      {

        "Key": "sample string 1",

        "Value": "sample string 2",

        "Operator": "LessThan"

      },

      {

        "Key": "sample string 1",

        "Value": "sample string 2",

        "Operator": "LessThan"

      }

    ]

  },

  "DataWarehouseTableName": "sample string 3",

  "Lists": [

    {

      "ListId": "sample string 1",

      "ListName": "sample string 2",

      "GroupName": "sample string 3"

    },

    {

      "ListId": "sample string 1",

      "ListName": "sample string 2",

      "GroupName": "sample string 3"

    }

  ],

  "ReportInformationList": [

    {

      "Hour": 1,

      "ReceiverEmails": [

        "sample string 1",

        "sample string 2"

      ]

    },

    {

      "Hour": 1,

      "ReceiverEmails": [

        "sample string 1",

        "sample string 2"

      ]

    }

  ],

  "ReportLanguage": "Turkish",

  "AdminReportTo": "sample string 4",

  "SubjectOptimization": {

    "Target": 1,

    "WaitInHour": 2

  },

  "ExtendedOptions": [

    {

      "Key": "sample string 1",

      "Value": "sample string 2"

    },

    {

      "Key": "sample string 1",

      "Value": "sample string 2"

    }

  ]

}


Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""
"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



SendSmsCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/SendSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/SendSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/SendSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/SendSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "DeliveryStartDateTime": "sample string 2",

  "DeliveryEndDateTime": "sample string 3",

  "Filter": {

    "Type": "Demographic",

    "Items": [

      {

        "Key": "sample string 1",

        "Value": "sample string 2",

        "Operator": "LessThan"

      },

      {

        "Key": "sample string 1",

        "Value": "sample string 2",

        "Operator": "LessThan"

      }

    ]

  },

  "Lists": [

    {

      "ListId": "sample string 1",

      "ListName": "sample string 2",

      "GroupName": "sample string 3"

    },

    {

      "ListId": "sample string 1",

      "ListName": "sample string 2",

      "GroupName": "sample string 3"

    }

  ],

  "ReportInformationList": [

    {

      "Hour": 1,

      "ReceiverEmails": [

        "sample string 1",

        "sample string 2"

      ]

    },

    {

      "Hour": 1,

      "ReceiverEmails": [

        "sample string 1",

        "sample string 2"

      ]

    }

  ],

  "MarketingPDFLanguage": "Turkish",

  "AdminReportTo": "sample string 4",

  "DataWarehouseTableName": "sample string 5"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


TestEmailCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/TestEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/TestEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/TestEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/TestEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "ListGroup": "sample string 2",

  "ListName": "sample string 3"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 

TestSmsCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/TestSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/TestSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/TestSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/TestSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "ListGroup": "sample string 2",

  "ListName": "sample string 3"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


UnlockCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/UnlockCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/UnlockCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/UnlockCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/UnlockCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 

UpdateEmailCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/UpdateEmailCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/UpdateEmailCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/UpdateEmailCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/UpdateEmailCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "Name": "sample string 2",

  "CampaignType": "SingleShot",

  "FromName": "sample string 3",

  "FromAddress": "sample string 4",

  "ReplyAddress": "sample string 5",

  "Subject": [

    "sample string 1",

    "sample string 2"

  ],

  "HtmlMessage": "sample string 6",

  "PreHeaderText": "sample string 7",

  "Locked": true,

  "ReadFlag": true,

  "ClickThroughFlag": true,

  "ShareThisFlag": true,

  "UniqueEmailFlag": true,

  "RateFlag": true,

  "OmnitureFlag": true,

  "GoogleAnalytics": true,

  "GoogleUtmSource": "sample string 16",

  "GoogleUtmMedium": "sample string 17",

  "GoogleUtmTerm": "sample string 18",

  "GoogleUtmContent": "sample string 19",

  "GoogleUtmCampaign": "sample string 20",

  "Speed": 21,

  "ExpireDate": "sample string 22"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


UpdateOffer 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/UpdateOffer

ECOMM: https://api.relateddigital.com/reste/api/Campaign/UpdateOffer

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/UpdateOffer

LIVEM: https://api.relateddigital.com/restm/api/Campaign/UpdateOffer

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "OfferID": 1,

  "OfferHtml": "sample string 2",

  "ExpireDate": "sample string 3"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",

      "Message": ""
    }
  ],
"DetailedMessage": ""

"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 


UpdateSmsCampaign 

Back to Top ^ 

URL

LIVE: https://api.relateddigital.com/resta/api/Campaign/UpdateSmsCampaign

ECOMM: https://api.relateddigital.com/reste/api/Campaign/UpdateSmsCampaign

LIVEB: https://api.relateddigital.com/liveb_rest/api/Campaign/UpdateSmsCampaign

LIVEM: https://api.relateddigital.com/restm/api/Campaign/UpdateSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: Login aksiyonundan sonra alınan Service Ticket değeri.

Body


Sample Body

{

  "CampaignId": "sample string 1",

  "Name": "sample string 2",

  "CampaignType": "SingleShot",

  "Originator": "sample string 3",

  "Locked": true,

  "SmsMessage": "sample string 5",

  "AlternateSmsMessage": "sample string 6",

  "UniqueSmsFlag": true,

  "Created": "sample string 8",

  "Updated": "sample string 9",

  "DeliveryStartDate": "sample string 10",

  "Status": "sample string 11"

}

Sample Response

{
"Success": false,

  "Errors": [
    {
      "Code": "",
      "Message": ""
    }
  ],
"DetailedMessage": ""
"TransactionId": ""
}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

Error Code

00, 01,12,29,76,87,88,90,99,101,107,129,130 



Ana Sayfa: RMC REST API

Copyright 2020 Related Digital