Skip to main content
PATCH
Update Campaign

Authorizations

X-API-Key
string
header
required

API Key for authentication

Path Parameters

id
string
required

Body

application/json
id
string<uuid>
required

Campaign id to update.

name
string
required

Updated display name.

Minimum string length: 1
voiceId
string<uuid>
required

Voice id the campaign should use after the update. Always required: detaching a Voice is intentionally not possible through this API (internally an omitted field would mean 'remove'), so pass the current voice.id to keep it or another valid id to switch.

skipTeammatesLeads
boolean
required

Prospects campaigns: skip profiles already present in teammates' campaigns. Enabling is rejected if duplicate prospects already exist; resolve those duplicates first. Keep the stored value for Topic campaigns.

commenting
object

Whole comment policy of the campaign. commenting is replaced as a whole, never deep-merged: omit it to leave the stored policy untouched, or state the complete policy you want. A scalar omitted inside a group that IS stated therefore means off/none, not “keep the stored value”. A TARGET_USER (Prospects) campaign states strategy, postFilters, frequency and feedCleanup, and may state indirectCommentingEnabled and publishingPace; a KEYWORD (Topic) campaign states strategy and postFilters only — every other member is People-only and must be omitted. Whole-policy replacement, not a deep merge. Omit to retain it, except that disabling the last warm-up comment path may change stored FINISH_FIRST to FRESHNESS_FIRST; re-read after that outreach change.

outreach
object

Optional deep-partial update of the private-outreach settings. Send only the nested fields that should change: omitted fields keep their stored value, an explicit false is applied, and the backend validates the merged result before saving it.

Response

status
string
required

Response status

Allowed value: "success"
data
null
required

No response payload

message
string
required

Success message

Example:

"Operation completed successfully"