POST api/Mail/SendTemplateMail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FileName	string	None.
DynamicContent	Dictionary of string [key] and string [value]	None.
SendMailProp	SendMailProp	None.

Request Formats

application/json, text/json

Sample:

{
  "FileName": "sample string 1",
  "DynamicContent": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "SendMailProp": {
    "Attachments": [
      {
        "AttachmentsType": "sample string 1",
        "AttachmentsName": "sample string 2",
        "AttachmentsPathbase64": "sample string 3"
      },
      {
        "AttachmentsType": "sample string 1",
        "AttachmentsName": "sample string 2",
        "AttachmentsPathbase64": "sample string 3"
      }
    ],
    "FromEmail": "sample string 1",
    "FromName": "sample string 2",
    "To": [
      {
        "ToEmail": "sample string 1",
        "ToName": "sample string 2"
      },
      {
        "ToEmail": "sample string 1",
        "ToName": "sample string 2"
      }
    ],
    "Html": "sample string 3",
    "Images": [
      {
        "ImagesType": "sample string 1",
        "ImagesName": "sample string 2",
        "ImagesPath": "sample string 3"
      },
      {
        "ImagesType": "sample string 1",
        "ImagesName": "sample string 2",
        "ImagesPath": "sample string 3"
      }
    ],
    "Subject": "sample string 4",
    "CC": [
      {
        "CCEmail": "sample string 1",
        "CCName": "sample string 2"
      },
      {
        "CCEmail": "sample string 1",
        "CCName": "sample string 2"
      }
    ],
    "BCC": [
      {
        "BCCEmail": "sample string 1",
        "BCCName": "sample string 2"
      },
      {
        "BCCEmail": "sample string 1",
        "BCCName": "sample string 2"
      }
    ],
    "EmailTag": "sample string 5"
  }
}

application/xml, text/xml

Sample:

<SendTemplateMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <DynamicContent xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </DynamicContent>
  <FileName>sample string 1</FileName>
  <SendMailProp>
    <Attachments>
      <AttachmentsApi>
        <AttachmentsName>sample string 2</AttachmentsName>
        <AttachmentsPathbase64>sample string 3</AttachmentsPathbase64>
        <AttachmentsType>sample string 1</AttachmentsType>
      </AttachmentsApi>
      <AttachmentsApi>
        <AttachmentsName>sample string 2</AttachmentsName>
        <AttachmentsPathbase64>sample string 3</AttachmentsPathbase64>
        <AttachmentsType>sample string 1</AttachmentsType>
      </AttachmentsApi>
    </Attachments>
    <BCC>
      <BCCApi>
        <BCCEmail>sample string 1</BCCEmail>
        <BCCName>sample string 2</BCCName>
      </BCCApi>
      <BCCApi>
        <BCCEmail>sample string 1</BCCEmail>
        <BCCName>sample string 2</BCCName>
      </BCCApi>
    </BCC>
    <CC>
      <CCApi>
        <CCEmail>sample string 1</CCEmail>
        <CCName>sample string 2</CCName>
      </CCApi>
      <CCApi>
        <CCEmail>sample string 1</CCEmail>
        <CCName>sample string 2</CCName>
      </CCApi>
    </CC>
    <EmailTag>sample string 5</EmailTag>
    <FromEmail>sample string 1</FromEmail>
    <FromName>sample string 2</FromName>
    <Html>sample string 3</Html>
    <Images>
      <ImagesApi>
        <ImagesName>sample string 2</ImagesName>
        <ImagesPath>sample string 3</ImagesPath>
        <ImagesType>sample string 1</ImagesType>
      </ImagesApi>
      <ImagesApi>
        <ImagesName>sample string 2</ImagesName>
        <ImagesPath>sample string 3</ImagesPath>
        <ImagesType>sample string 1</ImagesType>
      </ImagesApi>
    </Images>
    <Subject>sample string 4</Subject>
    <To>
      <ToApi>
        <ToEmail>sample string 1</ToEmail>
        <ToName>sample string 2</ToName>
      </ToApi>
      <ToApi>
        <ToEmail>sample string 1</ToEmail>
        <ToName>sample string 2</ToName>
      </ToApi>
    </To>
  </SendMailProp>
</SendTemplateMail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponseOfBoolean

Name	Type	Additional information
Result	boolean	None.
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": true,
  "Version": "1.0.0",
  "dateTime": "2025/05/20 14:41:56",
  "StatusCode": 2,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample:

<VCAPIResponseOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 3</ErrorMessage>
  <Result />
  <StatusCode>2</StatusCode>
  <Result>true</Result>
</VCAPIResponseOfboolean>