Documentation / API / campaigns_rerun_research
campaigns_rerun_research
POSThttps://api.oppalerts.com/v1/campaigns/rerun_research
Restarts a campaign’s research after it stopped.
What it does
The tool restarts a campaign’s research after it stopped. campaigns_settings shows the state of the research in research.
Only the steps that did not finish run again. Completed steps are not repeated. When the research is not stopped, nothing changes.
The response contains the campaign after the call. In the web app, Edit Campaign makes the same request.
Who May Call It
- The account owner, an account editor, or a campaign editor of this campaign. An account viewer or a campaign viewer gets the error
no_access. - The token needs the scope
api:write, andapi:readas every API route does. Withoutapi:write, the call gets the errorforbidden. Authentication says which tokens have it.
Authentication
Send your token in the Authorization: Bearer header. The API overview explains how to get a token. The API also accepts the same call at POST /v1/campaigns_rerun_research.
Parameters
campaignint, required, 1 to 4294967295- The campaign id, from campaigns_list. It must be a campaign of your account.
Rules
campaignis required. The tool takes no other field.- The tool does not perform lengthy work during the call.
- An archived campaign is refused with
campaign_archived. Make it active first with campaigns_activate.
Strict Rules
- A field that is not in the list above is refused. The answer is HTTP 400 with the error code
bad_param. The error names the field: "<field> is not a field of this tool." - A bad value is refused, and the error names the field. A bad value is a value of the wrong type, a number with a fraction for a whole-number field, a value out of its range, a value that is not in its list, or an empty text, list, or object. A required field that you do not send is refused too. To send no value for an optional field, leave the field out. No field has a default value, and the tool never changes a value that you send.
- An error about the format of a call, such as a refused field, names the field. Its message ends with one sentence: "Read the documentation at https://oppalerts.com/docs for the correct format." Every other error, such as
forbiddenbelow, has only its own sentence.
Response fields
The response contains the campaign after the change, in the same format that campaigns_settings returns.
campaign.idint- The campaign id.
campaign.labelstring- The name of the campaign.
campaign.industrystring- The industry of the campaign.
campaign.descriptionstring- The description of the campaign. It is an empty string when the campaign has none.
campaign.statestring- The state of the campaign. The example shows
active. campaign.finalizedbooltruewhen the campaign is finalized.campaign.finalized_atstring- The time when the campaign was finalized, as ISO 8601 text in UTC. Empty when
finalizedisfalse. campaign.researchstring- The progress of the campaign’s research, with the values of
researchin campaigns_list. The example showsnot_started. campaign.started_atstring- The time when the campaign last counted as a start in the plan limit of campaigns started in 24 hours, as ISO 8601 text in UTC: its create, or campaigns_activate of a campaign that was never finalized. Empty when the campaign has no such time.
campaign.taxonomy_presetslist- The taxonomy presets of the campaign. Each item is one taxonomy category.
campaign.taxonomy_presets[].taxonomystring- The taxonomy of the category, as taxonomy_taxonomies names it.
campaign.taxonomy_presets[].category_idint- The id of the category.
campaign.taxonomy_presets[].category_labelstring- The label of the category, for example
Travel > Travel Type > Hotels and Motels. campaign.daily_opportunities_emailobject- The daily opportunities email settings of the campaign.
campaign.daily_opportunities_email.enabledbooltruewhen the daily opportunities email is on.campaign.daily_opportunities_email.emailstring- The address that gets the daily opportunities email.
campaign.daily_opportunities_email.first_namestring- The first name used in the daily opportunities email.
campaign.daily_opportunities_email.send_hourint- The hour of the day when the daily opportunities email is sent, in
campaign.daily_opportunities_email.timezone. campaign.daily_opportunities_email.timezonestring- The time zone of
send_hour, for exampleAmerica/Los_Angeles. campaign.daily_opportunities_email.unsubscribedbooltruewhen the address unsubscribed from the daily opportunities email.campaign.daily_opportunities_email.unsubscribed_atstring- The time when the address unsubscribed with the link in the email, as ISO 8601 text in UTC. Empty when
unsubscribedisfalse.
Example
Request
curl -X POST https://api.oppalerts.com/v1/campaigns/rerun_research \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"campaign": 124}'
Response
The response is shown in full.
{
"campaign": {
"id": 124,
"label": "Boutique Hotels",
"industry": "Boutique hotels",
"description": "Boutique hotel brands competing for direct bookings in mid-size US cities, against the online travel agencies and the big hotel chains.",
"state": "active",
"finalized": false,
"finalized_at": "",
"research": "not_started",
"started_at": "2026-11-01T15:04:05Z",
"taxonomy_presets": [
{
"taxonomy": "iab-content-taxonomy",
"category_id": 2358064203319202,
"category_label": "Travel > Travel Type > Hotels and Motels"
}
],
"daily_opportunities_email": {
"enabled": true,
"email": "pat@example.com",
"first_name": "Pat",
"send_hour": 7,
"timezone": "America/Los_Angeles",
"unsubscribed": false,
"unsubscribed_at": ""
}
}
}
Errors
An error has an HTTP status and a JSON body with error, the error code, and error_description, the message. An example: a call with a token that does not have the scope api:write. This answer also has a WWW-Authenticate header with error="insufficient_scope" and the scopes that the call needs.
HTTP/1.1 403 Forbidden
WWW-Authenticate: Bearer error="insufficient_scope", scope="api:read api:write", resource_metadata="https://api.oppalerts.com/.well-known/oauth-protected-resource/v1", error_description="This token cannot change data. Make a new API token with edit permissions on the API tokens page, or connect the app again and allow changes."
Content-Type: application/json
{
"error": "forbidden",
"error_description": "This token cannot change data. Make a new API token with edit permissions on the API tokens page, or connect the app again and allow changes."
}
The error codes of this tool, each with its HTTP status and its sentence:
bad_param(HTTP 400): A parameter is missing or has a wrong value. The sentence names it.no_campaign(HTTP 404): That campaign is not in this account.forbidden(HTTP 403): This token cannot change data. Make a new API token with edit permissions on the API tokens page, or connect the app again and allow changes.no_access(HTTP 403): You have read permissions for this campaign.db_error(HTTP 500): The change could not be saved. Nothing was changed.campaign_archived(HTTP 409): Not started: this campaign is archived. Make it active first.
Limits
- This tool has its own daily count for the account. When the count is used up, the call is refused with
daily_limit(HTTP 429). account_calls_left shows the calls left today and when the count resets. - A refused call does not use the daily count of this tool.
- This tool is not an index search. It does not use the daily count of index searches.
- Only one change runs at a time per account. A call made while another change is running for the account is refused with
one_at_a_time(HTTP 429) and uses no daily call. Send it again after a few seconds.
Same tool in MCP
The MCP tool is campaigns_rerun_research. See campaigns_rerun_research in MCP.