Sets default attributes on document recipients for a specified quote document based on its attached Lightning flexipage layout.
This action is available in API version 68.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/setLsQuoteDocumentDefaults
Where XX.X is the latest API version.
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is your OAuth access token.
Inputs
| Input | Type | Description |
|---|---|---|
| quoteDocumentId | String | Required The ID of the Quote Document record for which to populate recipient default properties. |
Outputs
| Output | Type | Description |
|---|---|---|
| errorDescription | String | Message detailing generic action failures when processing the quote document defaults. |
| inputErrorDescription | String | Error message displayed when a valid quote document ID parameter is missing from the request. |
| templateNotFound | String | Error message returned when document template details aren't found for the specified quote document. |
| flexiPageDetailsNotFound | String | Error message returned when flexipage layout details can't be retrieved for the quote document. |
| signaturePlaceholderNotFound | String | Error message returned when a Life Sciences signature component placeholder isn't found in the document template layout. |
| unableToUpdateDocumentRecipient | String | Error message displayed when updating the document recipient record with the default signature identifier fails. |
Example
Sample Request
{
"inputs": [
{
"quoteDocumentId": "0QDxx0000004CQmGAM"
}
]
}
Sample Response
[
{
"actionName": "setLsQuoteDocumentDefaults",
"errors": null,
"isSuccess": true,
"outputValues": {
"errorDescription": null,
"inputErrorDescription": null,
"templateNotFound": null,
"flexiPageDetailsNotFound": null,
"signaturePlaceholderNotFound": null,
"unableToUpdateDocumentRecipient": null
}
}
]