MMetadata /docs
Docs/Tools/unarchive_audience

unarchive_audience

Unarchive (restore) a previously archived custom audience on the Metadata platform.

Writes audiences

Creates or changes something in the account. Put it behind whatever review your agent uses.

What it does

Unarchive (restore) a previously archived custom audience on the Metadata platform.
                        Use this tool when the user wants to unarchive, restore, or reactivate a custom audience.

                        You can identify the audience either by its numeric custom_audience_id or by its name.
                        If only the audience name is provided, the tool will search existing audiences to resolve the correct ID before unarchiving.

                        PARAMETERS:
                        • custom_audience_id (optional): The numeric ID of the custom audience to unarchive.
                        • audience_name (optional): The name of the custom audience to unarchive. Used to look up the ID if custom_audience_id is not provided.

                        At least one of custom_audience_id or audience_name must be provided.

                        RESPONSE:
                        • actionStatus: "SUCCEEDED" if the audience was unarchived successfully.

Arguments

ArgumentTypeNotes
custom_audience_id integer The numeric ID of the custom audience to unarchive.
audience_name string The name of the custom audience to unarchive. If provided without custom_audience_id, the tool will search for the audience by name to resolve the ID.

Request

Request template, not a complete runnable example. Replace placeholders, empty objects, arrays, and zero values with valid account-specific inputs. Read required fields and nested constraints in the full schema. Confirm the account, connected channels, and referenced assets before calling a write tool.

curl
curl -s -X POST https://mcp-server.metadata.io/mcp \
  -H "Authorization: $METADATA_PAT" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -H "MCP-Protocol-Version: 2025-11-25" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"unarchive_audience","arguments":{}}}'

Response

No recorded response. This tool writes to the account, so it is never executed to build these docs. The request is an illustrative template. Fill required fields and check the current schema before calling it. No response is fabricated.

Other audiences tools:

Browse the tool catalog · machine-readable index