Deliver Audience
deliver_audienceDeliver an audience as a download using available organization subscription capacity. Required capacity depends on the selected records, attributes, and existing licenses. Supply template_id OR field_list — not both. Review the subscription capacity estimate from quote_delivery with the user before starting delivery. Returns delivery progress and signed download links once completed. Completion or failure may notify configured external webhooks and opted-in users by email; completion may also email the delivery creator and configured organization contacts. Requires 'creator' 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": "deliver_audience"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field_list | No | Custom list of field names (alternative to template_id) | |
| audience_id | Yes | Audience to deliver | |
| destination | Yes | Active delivery destination | |
| template_id | No | Enrichment template ID from get_field_catalog() | |
| output_format | No | Output file format for download deliveries. Omit to auto-detect: matched audiences default to their uploaded file format; all others default to csv. | |
| include_unmatched | No | (matched subtype) Include rows that did not resolve to a real graph match — these get a best-effort derived iag_person_id (or null), not a real match. Defaults to true. | |
| output_compression | No | Explicit download compression. gzip supports csv/json/jsonl; Avro uses native DEFLATE and rejects outer gzip. Never inherited from input compression. | none |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | Yes | ||
| status | Yes | Current delivery state | |
| guidance | No | Interpretation or recovery guidance for this result | |
| 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. | |
| delivery_id | Yes | ||
| destination | Yes | ||
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| download_urls | No | Fresh signed artifact URLs on an individual completed download delivery | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions |