Skip to main content
PATCH
/
api
/
client
/
v2
/
campaign
/
{id}
Update Campaign
curl --request PATCH \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/campaign/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "userStyleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userContextId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "postMaxAgeDays": 4503599627370495,
  "skipTeammatesLeads": true,
  "isIndirectEngagementEnabled": true,
  "postActivityFilter": {
    "emotionTypes": [],
    "monitoredTopicIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "isShowImportantTargetUsersFirstEnabled": true,
    "isShowDirectPostFirstEnabled": true,
    "minPostLikes": 25
  },
  "connectingSettings": {
    "isSendConnectionRequestEnabled": true,
    "sendConnectionRequestOnDirectCommentCount": 4503599627370495,
    "isSendConnectionRequestOnIndirectCommentEnabled": true,
    "sendConnectionRequestOnIndirectCommentCount": 4503599627370495,
    "isSendConnectionRequestOnTimeoutEnabled": true,
    "sendConnectionRequestOnTimeoutDays": 4503599627370495,
    "isSendConnectionRequestOnNoPostsEnabled": true
  },
  "dmSettings": {
    "isGenerateDmEnabled": true,
    "isGenerateDmOnConnectEnabled": true,
    "generateDmOnConnectAfterDaysCount": 4503599627370495,
    "isGenerateDmOnRelevantPostEnabled": true,
    "generateDmOnRelevantPostAfterDaysCount": 4503599627370495,
    "isGenerateDmOnTimeoutEnabled": true,
    "generateDmOnTimeoutAfterDaysCount": 4503599627370495
  },
  "applyCommentIntervalH": 4503599627370495
}
'
{
  "status": "success",
  "data": null,
  "message": "Operation completed successfully"
}

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
​
userStyleId
string<uuid>
required

Style id the campaign should use after the update. Always required — the backend treats omission as 'remove' and rejects active campaigns.

​
userContextId
string<uuid>
required

Context id the campaign should use after the update. Always required — the backend treats omission as 'remove' and rejects active campaigns.

​
postMaxAgeDays
integer
required

Legacy field, ignored at runtime. Required by the validator — pass the campaign's current value (or 30) unchanged.

Required range: 0 < x <= 9007199254740991
​
skipTeammatesLeads
boolean
required

If true, skip prospects that are already in teammates' campaigns in the same team — avoids double outreach to the same person.

​
isIndirectEngagementEnabled
boolean
required

Indirect engagement feature. If true, Extrovert also pulls indirect posts — posts from the people the prospect engages with most frequently (content the prospect is likely to see in their own feed) — so the campaign can comment on them too. Useful for reaching prospects who rarely post themselves.

​
postActivityFilter
object
required

Optional updated postActivityFilter. For KEYWORD campaigns fewer fields apply by logic (filter is oriented at working with specific prospects).

​
connectingSettings
object
required

Optional updated connection-request settings.

​
dmSettings
object
required

Optional updated DM-generation settings.

​
applyCommentIntervalH
integer

Optional: minimum gap in hours between automated comments (spreads approved comments over time so engagement feels natural). Stored in hours but the UI only exposes whole-day choices — pass a multiple of 24 (24, 48, or 72). Omit to keep the feature off.

Required range: 0 < x <= 9007199254740991

Response

​
status
enum<string>
required

Response status

Available options:
success
​
data
any | null
required

No response payload

Available options:
null
Example:

null

​
message
string
required

Success message

Example:

"Operation completed successfully"