Campaigns / TypeScript SDK

Update campaign settings

Name: Pipeline
Price: 99 USD

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.

pipeline.updateCampaignSettingsDeterministic operation

Parameters

workspaceIdOptional · string: Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
campaignIdRequired · string: See the input schema for this field.
expectedUpdatedAtRequired · string: Required optimistic-concurrency token from the latest get-campaign updated_at value.
dailyLimitOptional · number: Shorthand for daily_limits.connections_per_account.
workingHoursOptional · object: See the input schema for this field.
daily_limitsOptional · object: See the input schema for this field.
timing_preferencesOptional · object: See the input schema for this field.
randomizationOptional · object: See the input schema for this field.
message_threadingOptional · object: See the input schema for this field.
safety_settingsOptional · object: Safety controls such as respect_linkedin_limits and pause_on_restriction.
dedupOptional · object: Cross-campaign dedupe controls such as excludeFromOtherCampaigns and sameSenderOnly.
enrollmentOptional · object: Capacity-aware enrollment controls such as throttle, max_in_flight_days, and icp_pass_buffer.
targetTimezoneOptional · string: Timezone used when presenting meeting times to prospects.
scheduled_startOptional · string: Optional ISO datetime for a scheduled campaign start.
scheduled_prospect_list_idsOptional · array: Prospect list ids used when the scheduled campaign starts.
triggerModeOptional · string: Campaign trigger mode.manual · evergreen_inbound

Request example

await pipeline.updateCampaignSettings({
  "campaignId": "00000000-0000-4000-8000-000000000000",
  "expectedUpdatedAt": "2026-01-01T00:00:00.000Z"
})

Full input schema

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "campaignId": {
      "type": "string"
    },
    "expectedUpdatedAt": {
      "type": "string",
      "description": "Required optimistic-concurrency token from the latest get-campaign updated_at value."
    },
    "dailyLimit": {
      "type": "number",
      "description": "Shorthand for daily_limits.connections_per_account."
    },
    "workingHours": {
      "type": "object",
      "properties": {
        "start": {
          "type": "string"
        },
        "end": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        }
      },
      "required": [
        "start",
        "end",
        "timezone"
      ]
    },
    "daily_limits": {
      "type": "object",
      "additionalProperties": true
    },
    "timing_preferences": {
      "type": "object",
      "additionalProperties": true
    },
    "randomization": {
      "type": "object",
      "additionalProperties": true
    },
    "message_threading": {
      "type": "object",
      "additionalProperties": true
    },
    "safety_settings": {
      "type": "object",
      "additionalProperties": true,
      "description": "Safety controls such as respect_linkedin_limits and pause_on_restriction."
    },
    "dedup": {
      "type": "object",
      "additionalProperties": true,
      "description": "Cross-campaign dedupe controls such as excludeFromOtherCampaigns and sameSenderOnly."
    },
    "enrollment": {
      "type": "object",
      "additionalProperties": true,
      "description": "Capacity-aware enrollment controls such as throttle, max_in_flight_days, and icp_pass_buffer."
    },
    "targetTimezone": {
      "type": "string",
      "description": "Timezone used when presenting meeting times to prospects."
    },
    "scheduled_start": {
      "type": "string",
      "description": "Optional ISO datetime for a scheduled campaign start."
    },
    "scheduled_prospect_list_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Prospect list ids used when the scheduled campaign starts."
    },
    "triggerMode": {
      "type": "string",
      "enum": [
        "manual",
        "evergreen_inbound"
      ],
      "description": "Campaign trigger mode."
    }
  },
  "required": [
    "campaignId",
    "expectedUpdatedAt"
  ]
}

See this operation inCLI MCP REST API