POST v1/Email/SendIndividual?EmailAddress={EmailAddress}

Send Individual Emails

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EmailAddress

string

Required

Body Parameters

EmailRequest
NameDescriptionTypeAdditional information
LineOfBusiness

string

String length: inclusive between 0 and 10

TemplateName

string

String length: inclusive between 0 and 60

Subject

string

String length: inclusive between 0 and 254

SubjectParams

Dictionary of string [key] and string [value]

None.

BodyParams

Dictionary of string [key] and string [value]

None.

Id

Primary Id

integer

None.

Expand

Comma separated list of expansions to include in results

string

None.

Request Formats

application/json, text/json

Sample:
{
  "LineOfBusiness": "sample string 1",
  "TemplateName": "sample string 2",
  "Subject": "sample string 3",
  "SubjectParams": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "BodyParams": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Id": 4,
  "Expand": ""
}

application/xml, text/xml

Sample:
<EmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>4</Id>
  <BodyParams 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>
  </BodyParams>
  <LineOfBusiness>sample string 1</LineOfBusiness>
  <Subject>sample string 3</Subject>
  <SubjectParams 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>
  </SubjectParams>
  <TemplateName>sample string 2</TemplateName>
</EmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.