Archive Segment
archive_segmentDestructiveIdempotent
Archive a segment to hide it from the default segment catalog and new audience compositions, or restore an archived one back to active. Archiving changes where the segment can be used; restoring it is a separate action. Archiving does not affect audiences that already reference this segment — their composition and record count are unchanged. This is distinct from permanently deleting a segment, which does change referencing audiences' composition and cannot be undone. 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": {
"segment_id": "<segment_id>"
},
"name": "archive_segment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| restore | No | Pass true to restore an archived segment back to active instead of archiving it | |
| segment_id | Yes | The segment ID to archive or restore |
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 | |
| segment_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 |