Search

Page tree

Versions Compared

Key

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

...

URL

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

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

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,

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

}

Sample Body

 {

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

}

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 

URL

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

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/campaign/StartEmailCampaign

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

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: http://api.relateddigital.com/resta/api/campaign/CancelSmsCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/campaign/CancelPushCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/campaign/StopPushCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/campaign/StartPushCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/campaign/CancelWebPushCampaign

ECOMM: http://api.relateddigital.com/reste/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 


...

URL

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

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/campaign/StartWebPushCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/AppendListToCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/CreateOffer 

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/CreateSmsCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/DeleteOffer

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/GetOffer 

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/LockCampaign

ECOMM: http://api.relateddigital.com/reste/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 

...

URL

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

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/QueryMemberCampaigns

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/QuerySmsCampaign

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/ SelectCanceledEmailCampaigns

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/ SelectCreatedEmailCampaigns

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/ SelectOngoingEmailCampaigns

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/ SelectScheduledEmailCampaigns

ECOMM: http://api.relateddigital.com/reste/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 

...

URL

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

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/ SendEmailCampaignWithExtendedOptions

ECOMM: http://api.relateddigital.com/reste/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: http://api.relateddigital.com/resta/api/Campaign/ SendSmsCampaign

ECOMM: http://api.relateddigital.com/reste/api/Campaign/ SendSmsCampaig

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 

...