Campaign Service

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

 Name(string): max 100 character campaign name,

 Subject(string []):subject array. For optimization, provide at most 3 subjects.,

 CampaignId(string): provide 32 byte guid like ,

 FromName(string):Provide a valid from name defined in your account,

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

Single Shot : One campaign, put & send

Template : Online campaign. Put & save & trigger.

Automatic : Periodic campaigns. Ask administrators for details.,

 FromAddress(string): provide a valid from address defined in your account,

 ReplyAddress(string): reply address. An valid e-mail address,

 HtmlMessage(string): html content of the campaign,

 PreHeaderText(string): Preheader text of campaign,

 Locked(bool): Optional parameter.,

 ReadFlag(bool): Optional parameter.,

 ClickThroughFlag(bool): Optional parameter.,

 ShareThisFlag(bool): Optional parameter.,

 UniqueEmailFlag(bool): Optional parameter. Make target list e-mail unique,

 RateFlag(bool): Optional parameter. Rate this newsletter function enabled,

 OmnitureFlag(bool): Optional parameter.,

 GoogleAnalytics(bool): Optional parameter.,

 GoogleUtmSource(string): Optional parameter.,

 GoogleUtmMedium(string): Optional parameter.,

 GoogleUtmTerm(string): Optional parameter.,

 GoogleUtmContent(string): Optional parameter.,

 GoogleUtmCampaign(string): Optional parameter.,

 Speed(int): Optional parameter.(Must be 1-5),

 ExpireDate(string): Optional parameter. Expire date of campaign

 {

  "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”:””

}

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

{

"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 }

{
"CampaignId":"",
"Name":"",
"Type":"",
"TextMessage":"",
"AlternateTextMessage":"",
"TargetUrl":"",
"DeliveryDate":"",
"DeliveryExpireDate":"",
"ReportAdmins":"false", 

"Application": {

"Name": "",
"Type": ""
}

}

{

"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

 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): ID of File,

 SpeedLimitation(int): Optional parameter.,

 DailyLimit(int): Optional parameter.,

 AbCustomization(string): Optional parameter. 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ü W= Web Push

}

{
"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"

}

]

}

{
"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

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.

{
"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"
}

{

"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

CampaignId(string): id of the e-mail campaign.,

DeliveryDateTime(string): format: yyyy-MM-dd HH:mm,

FilterType(int): Which filter will be used for targeting. 1 for Demographic, 2 for DataWarehouse,

Filters(Filter[]): Filter array which includes key,value, operator.

{

Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants like Name, Surname as configured by using Euro.Message admin panel,

Value(string): This is the value of the Key Column,

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

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

}

DataWarehouseTableName(string): Data Warehouse table name,

AdminReportTo(string): campaign start and finish reports to whom. delimeted by ; ,

ReportLanguage: Language of the report.(Turkish = 1,English = 2),

Lists(SendList []): Send list array.

{

  GroupName(string): list group name,

  ListName(string): list name under groupName.

}

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

{

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

ReceiverEmails(string[]): receiver email list.

},

SubjectOptimization(SubjectOptimization):

{

Target(short): Target percentage. Use 10% if you enable subject optimization by giving more than one subject in CreateEmailCampaign,

WaitInHour(short): After Target percentage is sent, how many hours to wait to decide which subject is better. Use 1 hour

}

 {

  "CampaignId": "",

  "DeliveryDateTime" :" ",

  "FilterType":"",

  "Filters":[{"Key":"", "Value":"","Operator":}],

  "DataWarehouseTableName":"",

  "Lists":[{“GroupName”:””,”ListName”:””}],

  "ReportInformationList":[{“Hour”:2, "ReceiverEmails":[] },{“Hour”:6, "ReceiverEmails":[] }],

  "ReportLanguage":1,

  "AdminReportTo":"",

  "SubjectOptimization":{“Target”:10, “WaitInHour”:1}

}

{

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

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