Change a campaign's settings

Its targeting, pacing, handoff, booking link, or who approves. Message text and the waits between steps are NOT settings. They belong to the campaign's playbook, whose single writer is the playbook builder, so invite_note_mode, invite_note_template, first_message_template and accept_wait_days are refused here. The campaign's status, project and source are not editable here either. Use the stop endpoint to stop it. A finished campaign answers 409: its settings are the record of what it ran with. Rate-limited to 60/hour per account, shared with the dashboard. Requires an outreach-scope API key (Pro plan or higher).

patch/api/v1/campaigns/{id}

Request

  • Base URL: https://www.easeclaw.com
  • URL: https://www.easeclaw.com/api/v1/campaigns/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

namestring
mode'autopilot' | 'copilot'

Who approves what goes out: autopilot: the agent approves inside the owner's limits; copilot: every batch waits for the owner. Neither mode is reachable from this API: it decides who approves, and this surface is not either of them.

followup_wait_daysinteger
withdraw_after_daysinteger nullable

Withdraw invitations unanswered this long. null turns auto-withdraw off.

email_handoff_enabledboolean
email_handoff_campaign_idstring nullable
meeting_linkstring uri nullable
signal_min_scoreinteger
icpobject nullable

null resets targeting to the project's ICP

goal'meeting' | 'reply' | 'share_link' | 'null' nullable

What the AI writes toward. null = not set.

tone'friendly' | 'professional' | 'direct' | 'casual' | 'null' nullable

null = not set.

language'en-US' | 'en-GB' | 'fr' | 'de' | 'es' | 'nl' | 'null' nullable

The language the AI writes in. null = follow the prospect's own language.

exclude_first_degreeboolean

Skip people you're already connected with on LinkedIn.

split_messagesboolean

Stored only. Not acted on yet.

email_fallback_daysinteger nullable

Stored only. null = off. The playbook's waits decide when an email step runs.

Response

The campaign as it now stands

Changes

No recorded changes to this operation across all 1 revision of this API.