Campaigns

Edit a Campaign

Changed on Nov 4, 2026

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

Request

Base URL
https://api.localfalcon.com
Auth
none declared

Request body application/x-www-form-urlencoded

api_keystring required

Your Local Falcon API key.

campaign_keystring required

The key of the campaign you wish to edit.

The edit action to perform on the campaign.

place_idstring

Google Place ID(s) of the campaign location(s) to act on. Supports a single value or multiple values separated by commas.

Required when action is add-location, modify-location, or remove-location.
Optional when action is add-keyword or update-keyword to scope the keyword(s) to specific location(s) already in the campaign.

keywordstring

The keyword(s) to act on. Supports a single value or multiple values separated by commas.

Required when action is add-keyword, update-keyword, or remove-keyword.

Keywords may contain the placeholders {category}, {city}, {locality}, {state}, {state_code}, {zip} and {country}, filled in per location at run time. See the keyword field on Create a Campaign for details. Never put a comma inside a keyword.

size'3' | '5' | '7' | '9' | '11' | '13' | '15' | '17' | '19' | '21'

Grid size for the campaign or location. Used with update-settings, add-location, or modify-location.

radiusstring

Grid radius from center point to the outermost point. Expects 0.1 to 100. Used with update-settings, add-location, or modify-location.

measurement'mi' | 'km'

The measurement unit of the radius. Used with update-settings, add-location, or modify-location.

platformsstring

Platforms to enable for the location, separated by commas. Used with add-location or modify-location.

Valid values: native (the location's own map platform, Google Maps or Apple Maps), google, apple, gaio, aimode, chatgpt, gemini.

keyword_type'traditional' | 'ai' | 'both'

The type of keyword(s) being added or modified. Used with update-settings, add-keyword, or update-keyword.

namestring

Updated name for the campaign. Used with update-settings.

ai_analysis'0' | '1'

Whether campaign scans should include AI analysis. Used with update-settings.

datestring

Next run date for the campaign. Expects MM/DD/YYYY. Used with update-settings. Must be provided together with time.

timestring

Next run time for the campaign. Expects friendly time like "9:00 AM". Used with update-settings. Must be provided together with date.

Updated run frequency for the campaign. Used with update-settings.

notify'0' | '1'

Whether email notification should be enabled for the campaign. Used with update-settings.

recipientsstring

Recipients of email notifications. Supports multiple email addresses separated by commas. Used with update-settings.

email_namestring

From-name used on email notifications. Pass |empty| to clear the value. Used with update-settings.

email_replytostring

Reply-to address used on email notifications. Pass |empty| to clear the value. Used with update-settings.

email_subjectstring

Subject line used on email notifications. Pass |empty| to clear the value. Used with update-settings.

email_bodystring

Body content used on email notifications. Pass |empty| to clear the value. Used with update-settings.

email_send_ai'0' | '1'

Whether AI analysis should be included in email notifications. Used with update-settings.

Example request

{
  "platforms": "native,chatgpt"
}

Response

Campaign updated successfully.

Changes

Nov 4, 2026304db93dea96 Revision changes
- breaking
  removed the enum value aimode of the request property
- breaking
  removed the enum value chatgpt of the request property
- breaking
  removed the enum value gaio of the request property
- breaking
  removed the enum value gemini of the request property
- breaking
  removed the enum value google of the request property
- breaking
  removed the enum value grok of the request property
- info
  added the new every-2-weeks enum value to the request property
- info
  added the new every-3-weeks enum value to the request property
- info
  added the new every-4-weeks enum value to the request property

Operation history