Skip to main content
PATCH
Update a campaign

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

campaign_uuid
string<uuid>
required

The unique identifier for the campaign.

Example:

"YOUR_CAMPAIGN_UUID"

Body

application/json

Fields marked draft-only (senders, lead_list_uuids, exclude, auto_finish) are refused once a campaign has started, and the whole request is rejected rather than partly applied.

name
string
description
string
senders
string<uuid>[]

UUIDs of the senders the campaign sends as, replacing the current ones. Send an empty array to remove them all. Draft campaigns only; the request is refused if the campaign has already started.

lead_list_uuids
string<uuid>[]

UUIDs of lead lists to use as the source of leads. Send an empty array to insert leads via the API instead of using lead lists. Draft campaigns only; the request is refused if the campaign has already started.

connection_request_limit
object
follow_up_limit
object
active_hours
object

Time window during which the campaign is active, as HH:MM in UTC at today's offset. The campaign keeps the matching local time in the workspace timezone, so the same window reads one hour different in UTC after a daylight saving change.

active_days
object
auto_finish
boolean
exclude
object

Response

Campaign updated

uuid
string<uuid>
status
enum<string>
Available options:
draft,
active,
inactive,
finished
name
string
description
string | null
campaign_type
enum<string>
Available options:
new_connections,
existing_connections
flow_enabled
boolean

Whether this is a flow campaign, whose steps are read and replaced through the campaign flow endpoint. Fixed when the campaign is created.

senders
string<uuid>[]

List of sender UUIDs assigned to this campaign.

connection_request_limit
object
follow_up_limit
object
active_hours_utc
object | null

Active hours as HH:MM in UTC at today's offset. The campaign follows the local time in the workspace timezone, so these values move by one hour across a daylight saving change.

active_days
object
lead_list_uuids
string<uuid>[]

UUIDs of lead lists to use as the source of leads. Send an empty array to insert leads via the API instead of using lead lists. Send an empty array to insert leads via the API instead of using lead lists.

exclude
object
auto_finish
boolean
finished_at
string<date-time> | null
updated_at
string<date-time>
created_at
string<date-time>