Estimate Delivery Capacity
quote_deliveryEstimate the subscription capacity required for a download using the audience version, selected fields, output settings, and current licenses. Saves a pending estimate and updates the audience estimate reference. Returns an expected amount and an upper bound, denominated in USD, together with available-capacity sufficiency and any shortfall. Active licenses reduce the expected identity component. When license information is unavailable, the expected amount equals the upper bound. The matching component for a file upload is included when applicable. Review the expected amount and upper bound with the user before delivery. Requires 'discovery' scope.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"audience_id": "<audience_id>",
"destination": "<destination>"
},
"name": "quote_delivery"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field_list | No | Custom field list (alternative to template_id) | |
| audience_id | Yes | Audience to quote | |
| destination | Yes | Active delivery destination; partner pushes are not yet available | |
| template_id | No | Enrichment template ID | |
| output_format | No | Requested download artifact format. | |
| output_compression | No | Requested download compression. gzip supports csv/json/jsonl; Avro uses native DEFLATE. | none |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| guidance | No | Interpretation or recovery guidance for this result | |
| shortfall | Yes | ||
| count_unit | No | ||
| page_count | No | Number of objects on this page, not the organization total | |
| audience_id | Yes | ||
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| destination | Yes | ||
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| cost_estimate | Yes | Expected subscription capacity consumption, denominated in USD | |
| license_pricing | Yes | ||
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions | |
| already_delivered | Yes | ||
| max_cost_estimate | Yes | Upper bound for subscription capacity consumption, denominated in USD | |
| sufficient_balance | Yes |