POST api/EmailGateway/SendEmail

Request Information

URI Parameters

None.

Body Parameters

EmailMessage
NameDescriptionTypeAdditional information
Body

string

Required

Subject

string

Required

To

string

Required

From

string

Required

CC

string

None.

Bcc

string

None.

Attachements

string

None.

BsCustomerID

string

None.

Category

string

Required

MetaData

Pair of string [key] and string [value]

Required

WebServiceKey

string

Required

CompanyId

integer

Required

Range: inclusive between 0 and 2147483647

Request Formats

application/json, text/json

Sample:
{
  "Body": "sample string 1",
  "Subject": "sample string 2",
  "To": "sample string 3",
  "From": "sample string 4",
  "CC": "sample string 5",
  "Bcc": "sample string 6",
  "Attachements": "sample string 7",
  "BsCustomerID": "sample string 8",
  "Category": "sample string 9",
  "MetaData": {
    "Key": "sample string 1",
    "Value": "sample string 2"
  },
  "WebServiceKey": "sample string 10",
  "CompanyId": 11
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseCodeBase
NameDescriptionTypeAdditional information
ResponseCode

string

None.

ResponseMessage

string

None.

CustomerID

string

None.

CompanyID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "CustomerID": "sample string 3",
  "CompanyID": 4
}