apiDeterministic
Update campaign settings
PUT /api/campaigns/{campaignId}/settings
Update campaign execution settings such as daily limits, working hours, randomization, and message threading. This is the same settings surface used by the web app.
Parameters
workspaceId
string
Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
campaignIdrequired
string
No description.
expectedUpdatedAtrequired
string
Required optimistic-concurrency token from the latest get-campaign updated_at value.
dailyLimit
number
Shorthand for daily_limits.connections_per_account.
workingHours
object
No description.
daily_limits
object
No description.
timing_preferences
object
No description.
randomization
object
No description.
message_threading
object
No description.
safety_settings
object
Safety controls such as respect_linkedin_limits and pause_on_restriction.
dedup
object
Cross-campaign dedupe controls such as excludeFromOtherCampaigns and sameSenderOnly.
enrollment
object
Capacity-aware enrollment controls such as throttle, max_in_flight_days, and icp_pass_buffer.
targetTimezone
string
Timezone used when presenting meeting times to prospects.
scheduled_start
string
Optional ISO datetime for a scheduled campaign start.
scheduled_prospect_list_ids
string[]
Prospect list ids used when the scheduled campaign starts.
triggerMode
string
Campaign trigger mode.
manual | evergreen_inbound
Example
REST requestbash
curl -X PUT "https://app.pipeline.help/api/campaigns/00000000-0000-4000-8000-000000000000/settings" \-H "Authorization: Bearer $PIPELINE_API_KEY" \-H "Content-Type: application/json" \-d '{"expectedUpdatedAt":"2026-01-01T00:00:00.000Z"}'
Response
The operation is available, but its typed response schema has not been published yet.
HTTP errors
- 401
- Missing or invalid API key.
- 403
- Authenticated but not permitted for the workspace or resource.
- 404
- The requested resource was not found.