Versions Compared

Key

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

...

FromName (string): From Name of the e-mail.,

FromAddress (string): From address of the e-mail.,

ReplyAddress (string): Reply address of the e-mail.,

Subject (string): Subject of the e-mail.,

HtmlBody (string): Content of the e-mail as html.,

Charset (string): Char set of the e-mail.,

ToName (string): Name of the receiver.,

ToEmailAddress (string): Email address of the receiver.,

PostType(string): Optional parameter.Type of email (account activation, survey, etc.).,

KeyId(string): Optional parameter. Unique member id  in your system.,

CustomParams(string): Optional parameter. Custom parameters.,

CcAddress(string): Optional parameter.,

BccAddress(string): Optional parameter.,

Attachments (List<Attachment>):

Attachment:

Name(string): Name of attachment.,

Type(string): Type like pdf,doc.,

Content(byte[]): Contents of file.

{

  "FromName": "sample string 1",

  "FromAddress": "sample string 2",

  "ReplyAddress": "sample string 3",

  "TemplateName": "sample string 4",

  "Xml": "sample string 5",

  "Charset": "sample string 6",

  "ToName": "sample string 7",

  "ToEmailAddress": "sample string 8",

  "Attachments": [

    {

      "Name": "sample string 1",

      "Type": "sample string 2",

      "Content": "QEA="

    },

    {

      "Name": "sample string 1",

      "Type": "sample string 2",

      "Content": "QEA="

    }

  ]

}

URL

LIVE: https://api.relateddigital.com/resta/api/post/PostTransactionalEmailWithXsltTemplate

ECOMM: https://api.relateddigital.com/reste/api/post/PostTransactionalEmailWithXsltTemplate

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostTransactionalEmailWithHtmlTemplate

LIVEM: https://api.relateddigital.com/restm/api/post/PostTransactionalEmailWithHtmlTemplate

Http verb

POST

Parameters

Header

Content-Type: application/json

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

Body

Sample Body

Sample Response

{
"MemberId": ""

"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

Succcess Response

Status Code: 200

http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

GetPostBulkBounceResult

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkBounceResult

ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkBounceResult

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkBounceResult

LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkBounceResult

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

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

...

Body

...

Sample Body

...

{

  "BeginDate": "sample string 1",

  "EndDate": "sample string 2"

}

...

Sample Response

...

{
"MemberId": ""

"Success": false,

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

"TransactionId": ""
}

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

GetPostBulkResult 

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResult

ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResult

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResult

LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResult

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

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

...

Body

...

Sample Body

...

{

  "BeginDate": "sample string 1",

  "EndDate": "sample string 2"

}

...

Sample Response

...

{
"MemberId": ""

"Success": false,

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

      "Message": ""
    }
  ],

"DetailedMessage": ""

"TransactionId": ""
}

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

GetPostBulkResultByLastUpdate

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultByLastUpdate

ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultByLastUpdate

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultByLastUpdate

LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultByLastUpdate

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

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

...

Body

...

Sample Body

...

{

  "BeginDate": "sample string 1",

  "EndDate": "sample string 2"

}

...

Sample Response

...

{
"MemberId": ""

"Success": false,

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

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

"TransactionId": ""
}

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

GetPostBulkResultByPostId 

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultByPostId 

ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultByPostId

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultByPostId

LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultByPostId

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

...

Body

...

Sample Body

{

  "PostIds": [

    "sample string 1",

    "sample string 2"

  ]

}

...

Sample Response

...

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

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

GetPostBulkResultWithCustomParams 

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultByPostId 

ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultWithCustomParams

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultWithCustomParams

LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultWithCustomParams

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

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

...

Body

...

Sample Body

...

{

  "BeginDate": "sample string 1",

  "EndDate": "sample string 2",

  "CustomParams": "sample string 3"

}

...

Sample Response

...

{
"MemberId": ""

"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

GetPostBulkResultWithOptional 

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/GetPostBulkResultWithOptional

ECOMM: https://api.relateddigital.com/reste/api/post/GetPostBulkResultWithOptional

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/GetPostBulkResultWithOptional

LIVEM: https://api.relateddigital.com/restm/api/post/GetPostBulkResultWithOptional

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

...

Body

...

ToEmailAddress (string): Email address of the receiver

PostType(string): Optional parameter.Type of email (account activation, survey, etc.)

...

Sample Body

...

{

  "BeginDate": "sample string 1",

  "EndDate": "sample string 2",

  "PostType": "sample string 3",

  "ToAddresss": "sample string 4"

}

...

Sample Response

...

{
"MemberId": ""

"Success": false,

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

      "Message": ""
    }
  ],

"DetailedMessage": ""

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

PostTransactionalEmailWithHtmlTemplate 

...

URL

...

LIVE: https://api.relateddigital.com/resta/api/post/PostTransactionalEmailWithHtmlTemplate 

ECOMM: https://api.relateddigital.com/reste/api/post/PostTransactionalEmailWithHtmlTemplate

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostTransactionalEmailWithHtmlTemplate

LIVEM: https://api.relateddigital.com/restm/api/post/PostTransactionalEmailWithHtmlTemplate

...

Http verb

...

POST

...

Parameters

...

Header

...

Content-Type: application/json

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

...

Body

FromName (string): From Name of the e-mail.,

FromAddress (string): From address of the e-mail.,

ReplyAddress (string): Reply address of the e-mail.,

Subject (string): Subject of the e-mail.,

HtmlBody (string): Content of the e-mail as html.,

Charset (string): Char set of the e-mail.,

ToName (string): Name of the receiver.,

ToEmailAddress (string): Email address of the receiver.,

PostType(string): Optional parameter.Type of email (account activation, survey, etc.).,

KeyId(string): Optional parameter. Unique member id  in your system.,

CustomParams(string): Optional parameter. Custom parameters.,

CcAddress(string): Optional parameter.,

BccAddress(string): Optional parameter.,

Attachments (List<Attachment>):

Attachment:

Name(string): Name of attachment.,

Type(string): Type like pdf,doc.,

Content(byte[]): Contents of file.

...

Sample Body

{

  "FromName": "sample string 1",

  "FromAddress": "sample string 2",

  "ReplyAddress": "sample string 3",

  "TemplateName": "sample string 4",

  "SubjectVariables": [

    {

      "Key": "sample string 1",

      "Value": "sample string 2"

    },

    {

      "Key": "sample string 1",

      "Value": "sample string 2"

    }

  ],

  "BodyVariables": [

    {

      "Key": "sample string 1",

      "Value": "sample string 2"

    },

    {

      "Key": "sample string 1",

      "Value": "sample string 2"

    }

  ],

  "Charset": "sample string 5",

  "ToName": "sample string 6",

  "ToEmailAddress": "sample string 7",

  "Attachments": [

    {

      "Name": "sample string 1",

      "Type": "sample string 2",

      "Content": "QEA="

    },

    {

      "Name": "sample string 1",

      "Type": "sample string 2",

      "Content": "QEA="

    }

  ]

}

...

Sample Response

...

{
"MemberId": ""

"Success": false,

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

      "Message": ""
    }
  ],

"DetailedMessage": ""

...

Succcess Response

...

Status Code: 200

...

Http Error Response

...

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

...

Error Code

...

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

PostTransactionalEmailWithXsltTemplate 

URL

LIVE: https://api.relateddigital.com/resta/api/post/PostTransactionalEmailWithXsltTemplate

ECOMM: https://api.relateddigital.com/reste/api/post/PostTransactionalEmailWithXsltTemplate

LIVEB: https://api.relateddigital.com/liveb_rest/api/post/PostTransactionalEmailWithXsltTemplate

LIVEM: https://api.relateddigital.com/restm/api/post/PostTransactionalEmailWithXsltTemplate

Http verb

POST

Parameters


Header

Content-Type: application/json

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

Body

FromName (string): From Name of the e-mail.,

FromAddress (string): From address of the e-mail.,

ReplyAddress (string): Reply address of the e-mail.,

Subject (string): Subject of the e-mail.,

HtmlBody (string): Content of the e-mail as html.,

Charset (string): Char set of the e-mail.,

ToName (string): Name of the receiver.,

ToEmailAddress (string): Email address of the receiver.,

PostType(string): Optional parameter.Type of email (account activation, survey, etc.).,

KeyId(string): Optional parameter. Unique member id  in your system.,

CustomParams(string): Optional parameter. Custom parameters.,

CcAddress(string): Optional parameter.,

BccAddress(string): Optional parameter.,

Attachments (List<Attachment>):

Attachment:

Name(string): Name of attachment.,

Type(string): Type like pdf,doc.,

Content(byte[]): Contents of file.


Sample Body

{

  "FromName": "sample string 1",

  "FromAddress": "sample string 2",

  "ReplyAddress": "sample string 3",

  "TemplateName": "sample string 4",

  "Xml": "sample string 5",

  "Charset": "sample string 6",

  "ToName": "sample string 7",

  "ToEmailAddress": "sample string 8",

  "Attachments": [

    {

      "Name": "sample string 1",

      "Type": "sample string 2",

      "Content": "QEA="

    },

    {

      "Name": "sample string 1",

      "Type": "sample string 2",

      "Content": "QEA="

    }

  ]

}


Sample Response

{
"MemberId": ""

"Success": false,

  "Errors": [

    {
      "Code": "",

      "Message": ""
    }
  ],

"DetailedMessage": ""

Succcess Response

Status Code: 200

http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

...