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

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

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,

Filter(Filter): .

{

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

Items:[

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.

}

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

{

"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

Filter and List can not be used at the same time.

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

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

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

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

Status Code: 200

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

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

Filter and List can not be used at the same time.

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to cancel ,

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

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

CampaignId(string): provide 32 byte guid like

{
"CampaignId":""
}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login.

CampaignId(string): provide 32 byte guid like

{
"CampaignId":""
}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login.

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to cancel ,

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

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login.

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to cancel ,

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

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login.

CampaignId(string): provide 32 byte guid like

{
"CampaignId":""
}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login.

CampaignId(string): provide 32 byte guid like

{
"CampaignId":""
}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to cancel ,

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

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login

CampaignId(string): provide 32 byte guid like

{
"CampaignId":""
}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successful login.

CampaignId(string): provide 32 byte guid like

{
"CampaignId":""
}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "CampaignId": "sample string 1",

  "ListGroup": "sample string 2",

  "ListName": "sample string 3"

}

{

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

OfferID: integer

OfferHtml: string

ExpireDate: string

{

  "OfferID": 1,

  "OfferHtml": "sample string 2",

  "ExpireDate": "sample string 3"

}

{
"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/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 successfull login.

{

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

}

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "OfferID": 1

}

{
"Success": false,

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

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "OfferID": 1

}

{
"Success": false,

  "Errors": [

    {
      "Code": "",

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

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "CampaignId": "sample string 1"

}

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "CampaignId": "sample string 1"

}

{

"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""

}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "MemberId": "sample string 1",

  "CampaignIds": [

    "sample string 1",

    "sample string 2"

  ]

}

{
"Success": false,

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

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "CampaignId": "sample string 1"

}

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "SinceDayAgo": 1

}

{
"Success": false,

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

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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: The ticket given by the system after successfull login.

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 

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "SinceDayAgo": 1

}

{
"Success": false,

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

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "SinceDayAgo": 1

}

{
"Success": false,

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

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "SinceDayAgo": 1

}

{
"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

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

    }

  ]

}

{
"Success": false,

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

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

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

}

{
"Success": false,

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

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "CampaignId": "sample string 1",

  "ListGroup": "sample string 2",

  "ListName": "sample string 3"

}

{
"Success": false,

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

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "CampaignId": "sample string 1",

  "ListGroup": "sample string 2",

  "ListName": "sample string 3"

}

{
"Success": false,

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

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

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

  "CampaignId": "sample string 1"

}

{
"Success": false,

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

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

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

{

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

}

{
"Success": false,

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

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

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

  "OfferID": 1,

  "OfferHtml": "sample string 2",

  "ExpireDate": "sample string 3"

}

{
"Success": false,

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

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

"TransactionId": ""
}

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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

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

POST

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

{

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

}

{
"Success": false,

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

Status Code: 200

Status Code: 400 Bad RequestStatus Code: 401 Unauthorized

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