POST api/NCService/SendEmail

Documentation for 'SendEmail'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "template_name": "sample string 1",
  "email_to": "sample string 2",
  "reply_to": "sample string 3",
  "variables": [
    {
      "key": "sample string 1",
      "value": "sample string 2"
    },
    {
      "key": "sample string 1",
      "value": "sample string 2"
    },
    {
      "key": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<SendEmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.NoneCredential">
  <email_to>sample string 2</email_to>
  <reply_to>sample string 3</reply_to>
  <template_name>sample string 1</template_name>
  <variables>
    <EmailVariable>
      <key>sample string 1</key>
      <value>sample string 2</value>
    </EmailVariable>
    <EmailVariable>
      <key>sample string 1</key>
      <value>sample string 2</value>
    </EmailVariable>
    <EmailVariable>
      <key>sample string 1</key>
      <value>sample string 2</value>
    </EmailVariable>
  </variables>
</SendEmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "is_success": true,
  "error_message": "sample string 2",
  "exception_name": "sample string 3",
  "error_code": 4
}

application/xml, text/xml

Sample:

<Void xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMS.RestApi.Entities.NewAPI">
  <error_code xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">4</error_code>
  <error_message xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 2</error_message>
  <exception_name xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">sample string 3</exception_name>
  <is_success xmlns="http://schemas.datacontract.org/2004/07/Mandoe.Framework.WebApi">true</is_success>
</Void>