POST quote/{quote}/document/email
Send an email attaching the document to the email.
Request Information
URI
https://ofd-api.blueprintcpq.net/quote/{quote}/document/email
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
quote |
Quote identifier |
globally unique identifier |
Required |
Body Parameters
List of email addresses and document Ids
EmailDocumentsName | Description | Type | Additional information |
---|---|---|---|
Emails | Collection of string |
None. |
|
Documents | Collection of globally unique identifier |
None. |
|
Message | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Emails": [ "sample string 1", "sample string 2" ], "Documents": [ "b7430f9d-9bbe-42e1-af83-adb04c24b081", "391a28fa-e3e0-477b-9bc4-b036b0112ce8" ], "Message": "sample string 1" }
text/html
Sample:
{"Emails":["sample string 1","sample string 2"],"Documents":["b7430f9d-9bbe-42e1-af83-adb04c24b081","391a28fa-e3e0-477b-9bc4-b036b0112ce8"],"Message":"sample string 1"}
application/xml, text/xml
Sample:
<EmailDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels"> <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>b7430f9d-9bbe-42e1-af83-adb04c24b081</d2p1:guid> <d2p1:guid>391a28fa-e3e0-477b-9bc4-b036b0112ce8</d2p1:guid> </Documents> <Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Emails> <Message>sample string 1</Message> </EmailDocuments>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
True if successful, otherwise false
booleanResponse 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>