Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


On this Page:

...

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

Body

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.

}

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.

...

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

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.

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/campaign/CancelSmsCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

Body

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to 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 


...

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

_liveb

/api/campaign/CancelPushCampaign

Http verb

POST

Parameters

Header

Content-Type: application/

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

Body

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to 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 


...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/campaign/StopPushCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

Body

CampaignId(string): provide 32 byte guid like


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 


...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/campaign/StartPushCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

Body

CampaignId(string): provide 32 byte guid like


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 


...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/campaign/CancelWebPushCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successful login

Body

CampaignId(string): provide 32 byte guid like ,

ForceCancelIfCampStarted(boolean): Forces campaign to 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 


...

Http

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

_liveb

/api/campaign/StopWebPushCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successful login

Body

CampaignId(string): provide 32 byte guid like


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 


...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/campaign/StartWebPushCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

Body

CampaignId(string): provide 32 byte guid like


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 


...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/AppendListToCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/CreateOffer

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

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

_liveb

/api/Campaign/CreateSmsCampaign

Http verb

POST

Parameters

Header

Content-Type: application/

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/DeleteOffer

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/GetOffer

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/LockCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

Http

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

_liveb

/api/Campaign/QueryEmailCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/QueryMemberCampaigns

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

URL

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

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

LIVEB:

http

 https:

s

//api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/QuerySmsCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/SelectCanceledEmailCampaigns

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/SelectOngoingEmailCampaigns

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/SelectScheduledEmailCampaigns

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

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 

...

SelectTestedEmailCampaigns 

URL

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

ECOMM: https://api.relateddigital.com/restareste/api/Campaign/SelectTestedEmailCampaignsECOMM

LIVEB: https://api.relateddigital.com/

reste

liveb_rest/api/Campaign/SelectTestedEmailCampaigns

LIVEB

LIVEM: https://api.relateddigital.com/

rest_liveb

restm/api/Campaign/SelectTestedEmailCampaigns

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/SendEmailCampaignWithExtendedOptions

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/SendSmsCampaign

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

SendSmsCampaign

SendSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/TestEmailCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

reste

liveb_rest/api/Campaign/TestSmsCampaign

LIVEB

LIVEM: https://api.relateddigital.com/

rest_liveb

restm/api/Campaign/TestSmsCampaign

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/UnlockCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/UpdateEmailCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/UpdateOffer

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...

URL

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

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

LIVEB: https://api.relateddigital.com/

rest_liveb

liveb_rest/api/Campaign/UpdateSmsCampaign

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

Http verb

POST

Parameters


Header

Content-Type: application/json

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

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 

...