v1

latestOpenAPI 3.0.32026-07-13404294.7 KB
Campaigns

Edit a Campaign

Edit an existing campaign. The fields required depend on the value of the action parameter:

<table> <colgroup> <col style="width: 22%"> <col style="width: 22%"> <col style="width: 56%"> </colgroup> <thead> <tr><th>Action</th><th>Required Additional Fields</th><th>Optional Additional Fields</th></tr> </thead> <tbody> <tr><td><code>update-settings</code></td><td><em>(none)</em></td><td><code>name</code>, <code>size</code>, <code>radius</code>, <code>measurement</code>, <code>ai_analysis</code>, <code>keyword_type</code>, <code>date</code>, <code>time</code>, <code>frequency</code>, <code>notify</code>, <code>email_name</code>, <code>email_replyto</code>, <code>email_subject</code>, <code>email_body</code>, <code>recipients</code>, <code>email_send_ai</code></td></tr> <tr><td><code>add-location</code></td><td><code>place_id</code></td><td><code>size</code>, <code>radius</code>, <code>measurement</code>, <code>platforms</code></td></tr> <tr><td><code>modify-location</code></td><td><code>place_id</code></td><td><code>size</code>, <code>radius</code>, <code>measurement</code>, <code>platforms</code></td></tr> <tr><td><code>remove-location</code></td><td><code>place_id</code></td><td><em>(none)</em></td></tr> <tr><td><code>add-keyword</code></td><td><code>keyword</code></td><td><code>place_id</code>, <code>keyword_type</code></td></tr> <tr><td><code>update-keyword</code></td><td><code>keyword</code></td><td><code>place_id</code>, <code>keyword_type</code></td></tr> <tr><td><code>remove-keyword</code></td><td><code>keyword</code></td><td><em>(none)</em></td></tr> </tbody> </table>

Many fields accept either a single value or a comma-delimited list of values (for example place_id, keyword, platforms).

A campaign cannot be modified while it is currently running — wait until the run finishes before calling this endpoint.

post/v2/campaigns/update

Response

Campaign updated successfully.