Skip to main content
PATCH
Update a campaign

Authorizations

X-Api-Key
string
header
required

API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.

Path Parameters

id
string
required

Body

application/json
name
string

New campaign name.

Maximum string length: 255
Example:

"Valencia Q3 2026"

mode
enum<string>

extract_only: scrape only. extract_and_contact: scrape + send WhatsApp sequence. Forced to extract_and_contact for csv_import and widget.

Available options:
extract_only,
extract_and_contact
Example:

"extract_and_contact"

platform
enum<string>

Change the platform (portal source) for this campaign.

Available options:
idealista,
fotocasa,
metrocuadrado,
inmuebles24,
zonaprop,
widget,
csv_import
Example:

"fotocasa"

contactMode
enum<string>

Outreach channel. whatsapp requires a connected WhatsApp Business account.

Available options:
whatsapp,
whatsapp-no-api
Example:

"whatsapp"

segmentation
object

Platform-specific segmentation object.

  • Portal: { filters: <portal-filter-object>, expectedResults: 50 }.
  • CSV import: { batchSize: 10 } (integer 1–25, required before going running).
  • Widget: leave empty.
Example:
settings
any

Scheduling and AI messaging settings.

allUrlsChecked
boolean

Mark incremental sync as completed for this campaign run.

Example:

false

Response

200 - undefined