XaitCPQ API

POST document/web/share/{document}

Share web document.

Request Information

URI

https://ofd-api.blueprintcpq.net/document/web/share/{document}

URI Parameters

NameDescriptionTypeAdditional information
document

The document.

 globally unique identifier

Required

Body Parameters

The share.

ForwardQuote
NameDescriptionTypeAdditional information
Share

globally unique identifier

None.
Email

string

None.
Message

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Share": "2c450cc5-869b-4ec2-8a4a-949a31df4c08",
  "Email": "sample string 1",
  "Message": "sample string 2"
}

text/html

Sample: 
{"Share":"2c450cc5-869b-4ec2-8a4a-949a31df4c08","Email":"sample string 1","Message":"sample string 2"}

application/xml, text/xml

Sample: 
<ForwardQuote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Email>sample string 1</Email>
  <Message>sample string 2</Message>
  <Share>2c450cc5-869b-4ec2-8a4a-949a31df4c08</Share>
</ForwardQuote>

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>