POST api/SendInBlueEmail/SendMail?TemplateId={TemplateId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
TemplateId

integer

Required

Body Parameters

SendMail
NameDescriptionTypeAdditional information
emailTo

Collection of string

None.

emailBcc

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "emailTo": [
    "sample string 1",
    "sample string 2"
  ],
  "emailBcc": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SendMail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <emailBcc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </emailBcc>
  <emailTo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </emailTo>
</SendMail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional information
Version

string

None.

dateTime

string

None.

StatusCode

integer

None.

ErrorMessage

string

None.

Result

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Version": "1.0.0",
  "dateTime": "2020/09/24 19:51:37",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

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