POST api/sendgrid/send

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ToList	Collection of string	None.
FromAddress	string	None.
Subject	string	None.
ContentDetails	EmailDetailDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "ToList": [
    "sample string 1",
    "sample string 2"
  ],
  "FromAddress": "sample string 1",
  "Subject": "sample string 2",
  "ContentDetails": {
    "UserFullName": "sample string 1",
    "TaskMessage": "sample string 2",
    "ProcessName": "sample string 3",
    "RegistrationEmail": true,
    "ForgotPassword": true,
    "TaskEmail": true,
    "TaskListEmail": {
      "CustomerName": "sample string 1",
      "CustomerID": 2,
      "SuperHeader": "sample string 3",
      "SupervisorTaskList": [
        "sample string 1",
        "sample string 2"
      ],
      "OpsHeader": "sample string 4",
      "OpsManagerTaskList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "ForgotPasswordContent": {
      "Message": "sample string 1",
      "Code": "sample string 2"
    },
    "CompanyRegistrationContent": {
      "WelcomeMessage": "sample string 1"
    },
    "SystemMaintenanceEmail": true,
    "Attachments": [
      {
        "FilePath": "sample string 1",
        "FriendlyName": "sample string 2",
        "ContentType": "sample string 3"
      },
      {
        "FilePath": "sample string 1",
        "FriendlyName": "sample string 2",
        "ContentType": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<EmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Email">
  <ContentDetails>
    <Attachments>
      <Attachments>
        <ContentType>sample string 3</ContentType>
        <FilePath>sample string 1</FilePath>
        <FriendlyName>sample string 2</FriendlyName>
      </Attachments>
      <Attachments>
        <ContentType>sample string 3</ContentType>
        <FilePath>sample string 1</FilePath>
        <FriendlyName>sample string 2</FriendlyName>
      </Attachments>
    </Attachments>
    <CompanyRegistrationContent>
      <WelcomeMessage>sample string 1</WelcomeMessage>
    </CompanyRegistrationContent>
    <ForgotPassword>true</ForgotPassword>
    <ForgotPasswordContent>
      <Code>sample string 2</Code>
      <Message>sample string 1</Message>
    </ForgotPasswordContent>
    <ProcessName>sample string 3</ProcessName>
    <RegistrationEmail>true</RegistrationEmail>
    <SystemMaintenanceEmail>true</SystemMaintenanceEmail>
    <TaskEmail>true</TaskEmail>
    <TaskListEmail>
      <CustomerID>2</CustomerID>
      <CustomerName>sample string 1</CustomerName>
      <OpsHeader>sample string 4</OpsHeader>
      <OpsManagerTaskList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </OpsManagerTaskList>
      <SuperHeader>sample string 3</SuperHeader>
      <SupervisorTaskList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SupervisorTaskList>
    </TaskListEmail>
    <TaskMessage>sample string 2</TaskMessage>
    <UserFullName>sample string 1</UserFullName>
  </ContentDetails>
  <FromAddress>sample string 1</FromAddress>
  <Subject>sample string 2</Subject>
  <ToList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ToList>
</EmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EmailResponse

Name	Type	Additional information
Success	boolean	None.
ErrorHint	string	None.
To	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Success": true,
    "ErrorHint": "sample string 2",
    "To": "sample string 3"
  },
  {
    "Success": true,
    "ErrorHint": "sample string 2",
    "To": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Email">
  <EmailResponse>
    <ErrorHint>sample string 2</ErrorHint>
    <Success>true</Success>
    <To>sample string 3</To>
  </EmailResponse>
  <EmailResponse>
    <ErrorHint>sample string 2</ErrorHint>
    <Success>true</Success>
    <To>sample string 3</To>
  </EmailResponse>
</ArrayOfEmailResponse>