Pause Experiment Keyword
pause_experiment_keywordPause a specific keyword running in an experiment.
PURPOSE:
Pause a keyword that is currently active in an experiment. This stops the keyword
from being used in the experiment without removing it entirely.
SCOPE - THIS TOOL ACTS ON ONE KEYWORD, NOT ON THE EXPERIMENT:
It pauses a SINGLE keyword INSIDE an experiment. The experiment itself keeps
running with its other keywords. To pause or restart a WHOLE experiment,
use manage_experiment instead.
WHEN TO USE:
- Pause an underperforming keyword in an experiment
- Temporarily stop a keyword from running in a specific experiment
- Manage keyword performance within experiments
PREREQUISITE:
Use list_experiment_keywords first to find the keywordExternalId and wizExperimentId
for the keyword you want to pause. Both come from that tool's results:
keywordExternalId identifies the keyword on the ad channel, and wizExperimentId
is the experiment's ID (the same ID search_experiments returns as experimentId).
WORKFLOW:
1. Search for the keyword: list_experiment_keywords(keywordOrExperimentName="my keyword")
2. Note the keywordExternalId and wizExperimentId from the results
3. Pause it: pause_experiment_keyword(keywordExternalId=12345, wizExperimentId=678)
4. (Optional) Verify later: list_experiment_keywords(keywordOrExperimentName="my keyword")
to check the status has changed
PARAMETERS:
- keywordExternalId: Required. The external ID of the keyword to pause (from list_experiment_keywords).
- wizExperimentId: Required. The experiment ID where the keyword is running (from list_experiment_keywords).
WARNING: This action changes the state of the keyword in the experiment.
The keyword will stop running in the specified experiment.
WARNING: ASYNC FLOW: Pausing a keyword is an asynchronous operation. The status change
may not be immediately reflected. Use list_experiment_keywords after some time
to verify the keyword status has been updated.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wizExperimentId | Yes | The experiment ID where the keyword is running. | |
| keywordExternalId | Yes | The external ID of the keyword to pause. |