ActionAddToOpportunityFromEstimateAsync
Pushes an estimate's role requests to its related opportunity as resource requests, and optionally creates matching opportunity products, in a background job. The estimate is locked and the work may not be complete when the action returns, so callers must acknowledge this and use the AddToOpportunityFromEstimatePlugin to chain any dependent work. Use this action instead of Add to Opportunity from Estimate for large estimates that would otherwise time out. Returns per-request errors captured before the job was enqueued.
| Property | Value |
|---|
| Label | Add to Opportunity from Estimate Asynchronously |
| Category | Estimates |
| Since | May 2024 |
| Read-only | No |
| Supports Agents | No |
| Supports Flows | Yes |
| Async Action | Yes |
| Keywords | add, aggregate, create, estimate, opportunity, opportunity product, asynchronous |
Request Parameters
| Field | Type | Label | Description | Required |
|---|
EstimateId | Id | Estimate ID | The ID of the estimate that contains the records being added to the related opportunity. | Yes |
EstimateProductIds | List<Id> | Estimate Product IDs | A list of IDs of the estimate product instances to be added to opportunity. | No |
IncludeRecordsIndependentOfEstimateProducts | Boolean | Include Records Independent of Estimate Products | If true, records independent of estimate products are added to the related opportunity. The default value is true. | No |
AdditionalAggregationFieldPaths | List<String> | Additional Role Request Consolidation Fields | Additional fields to consolidate estimate role requests by when creating resource requests. | No |
AggregateBySkills | Boolean | Consolidate by Skills | If true, role requests are consolidated by skills. The default value is false. | No |
CreateOpportunityLineItems | Boolean | Create Opportunity Products | If true, opportunity products are created for each estimate product instance. The default value is true. | No |
GroupingConfiguration | String | Grouping Criteria Configuration | The grouping criteria fields configuration to use when consolidating role requests into resource requests, enter either API_INPUT_GROUPING or ESTIMATE_STORED_GROUPING. When set to ESTIMATE_STORED_GROUPING, AdditionalAggregationFieldPaths and AggregateBySkills are ignored from the grouping criteria configuration. The default is API_INPUT_GROUPING. | No |
Acknowledgement | Boolean | Async Action Caution Acknowledged | If set to true, you confirm that you understand that this asynchronous action may not have completed before the next step in the flow is executed. Subsequent actions therefore should not depend on the completion of the Add to Opportunity from Estimate Asynchronously action. They must also not affect the same estimate as the action because the estimate will be locked while the action is in progress. Instead, you can trigger an action using the AddToOpportunityFromEstimatePlugin subsequent to the completion of the Add to Opportunity from Estimate Asynchronously action. | Yes |
Response Parameters
| Field | Type | Label | Description | Required |
|---|
EstimateId | Id | Estimate ID | The ID of the estimate that contains the records being added to the related opportunity. | Yes |
Errors | List<InvocableAddToOppFromEstimateAsyncError> | Errors | A list containing errors that occurred while processing the request. | No |
| 