Archive Audience
archive_audienceArchive a saved audience to hide it from the default list, or restore it with restore=true. Preserves its composition and delivery history. Requires the creator scope. 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>"
},
"name": "archive_audience"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| restore | No | True restores an archived audience to active | |
| audience_id | Yes | Saved audience ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| 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. | |
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions |