XaitCPQ API

POST email/mergeandsend

Merge and send.

Request Information

URI

https://ofd-api.blueprintcpq.net/email/mergeandsend

URI Parameters

None.

Body Parameters

The model.

MergeAndSendEmail
NameDescriptionTypeAdditional information
TemplateName

string

None.
EmailTo

Collection of string

None.
EmailCC

Collection of string

None.
EmailBCC

Collection of string

None.
Properties

Collection of Pair of string [key] and string [value]

None.
AttachmentIds

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "TemplateName": "sample string 1",
  "EmailTo": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailCC": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailBCC": [
    "sample string 1",
    "sample string 2"
  ],
  "Properties": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "AttachmentIds": [
    "c11657ab-109f-4b70-bd7c-ea5702164b36",
    "18a68ee6-3e00-428b-ab2f-306f6585320c"
  ]
}

text/html

Sample: 
{"TemplateName":"sample string 1","EmailTo":["sample string 1","sample string 2"],"EmailCC":["sample string 1","sample string 2"],"EmailBCC":["sample string 1","sample string 2"],"Properties":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"AttachmentIds":["c11657ab-109f-4b70-bd7c-ea5702164b36","18a68ee6-3e00-428b-ab2f-306f6585320c"]}

application/xml, text/xml

Sample: 
<MergeAndSendEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <AttachmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>c11657ab-109f-4b70-bd7c-ea5702164b36</d2p1:guid>
    <d2p1:guid>18a68ee6-3e00-428b-ab2f-306f6585320c</d2p1:guid>
  </AttachmentIds>
  <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>
  <EmailCC xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailCC>
  <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>
  <Properties xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Properties>
  <TemplateName>sample string 1</TemplateName>
</MergeAndSendEmail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

True if it succeeds, false if it fails.

boolean

Response Formats

application/json, text/json, text/html

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>