/
Post Service

Post Service

Dec 19, 2022

On this Page:

 

PostHtml 

URL

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

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

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

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

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.

Attachments (List<Attachment>):

Attachment:

Name(string): Name of attachment

Type(string): Type like pdf,doc.

Content(base64Binary): Contents of file

Sample Body

{
"FromName": "",
"FromAddress": "",
"ReplyAddress": "",
"Subject": "",
"HtmlBody": "<html><head></head><body>Hello World!!</body></html>",
"Charset": "iso-8859-9",
"ToName": "",
"ToEmailAddress": "",
"Attachments": [
{
"Name": "",
"Type": "PDF or DOC",
"Content": ""
}
],
"PostType": "",
"KeyId": "",
"CustomParams": ""
}

 

Sample Response

{

"PostId":”F50656781FFA45338C1F28499555A0BC”

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Successs 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



PostHtmlWithTypeCCandBCC

URL

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

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

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

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

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(base64Binary): Contents of file

Sample Body

{
"FromName": "",
"FromAddress": "",
"ReplyAddress": "",
"Subject": "",
"HtmlBody": "<html><head></head><body>Hello World!!</body></html>",
"Charset": "iso-8859-9",
"ToName": "",
"ToEmailAddress": "",
"CcAddress":"",
"BccAddress":"",
"Attachments": [
{
"Name": "",
"Type": "PDF or DOC",
"Content": ""
}
],
"PostType": "",
"KeyId": "",
"CustomParams": ""
}

 

Sample Response

{

"PostId":”F50656781FFA45338C1F28499555A0BC”

"Success": false,

  "Errors": [

    {

      "Code": "",

      "Message": ""

    }

  ],

"DetailedMessage": ""

"TransactionId": ""

}

Successs 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



GetPostResult

URL

LIVE: https://api.relateddigital.com/resta/api/Post/GetPostResultPostId=58D3A9E86C734F599BB87CBD87E3A531

ECOMM: https://api.relateddigital.com/reste/api/Post/GetPostResultPostId=58D3A9E86C734F599BB87CBD87E3A531

LIVEB: https://api.relateddigital.com/liveb_rest/api/Post/GetPostResultPostId=58D3A9E86C734F599BB87CBD87E3A531

LIVEM: https://api.relateddigital.com/restm/api/Post/GetPostResultPostId=58D3A9E86C734F599BB87CBD87E3A531

Http verb

GET

Parameters

PostId(string): ID of the post given by PostHtml web service.

Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

 

Sample Body

 

Sample Response

{

  "PostId": "58D3A9E86C734F599BB87CBD87E3A531",

  "RelayStatus": "R",

  "DeliveryStatus": "RE",

  "UndeliveryReason": "",

  "MarkedSpam": false,

  "KeyId": "",

  "CustomParams": "",

  "PostType": "rest_type",

  "ReadTime": "",

  "RelayBounceTime": "",

  "LastUpdateTime": "",

  "FromAdress": null,

  "Subject": null,

  "Success": true,

  "Errors": [],

  "DetailedMessage": "",

  "TransactionId": "63259CB6EE6543219A4E37575A94655F"

}

Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01, 26, 99

 

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

Copyright 2020 Related Digital