Campaigns

Update a campaign

Updates campaign settings. Only allowed while the campaign is in draft or paused status.

Required scope: campaigns:write.

The create, read and update responses carry opt_out_effective: the opt-out this campaign will actually print, after the per-campaign override falls back to your workspace setting field by field. style_source and text_source say which of the two each half came from; company_address is the postal address the footer prints (company_address_source: campaign, workspace or none).

Custom wording changes what the opt-out says, never whether one appears — every cold email carries one.

patch/campaigns/{id}

Request

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

Path parameters

idstring required

Campaign id (UUID).

Request body

namestring

Campaign name.

descriptionstring

Description.

dailySendLimitinteger

Daily send cap.

sendingWindowStartinteger

Window start hour.

sendingWindowEndinteger

Window end hour.

scheduleDaysinteger[]

Days of the week this campaign may send on. Numbers use 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday (Sunday is 0, not Monday). Day names such as "mon" or "monday" are accepted too and are the safest choice. Order and repeats do not matter. Leave it out for Monday–Friday [1,2,3,4,5]; an empty list is refused because a campaign with no sending days could never send.

stopOnReplyboolean

Stop on reply.

stopOnBounceboolean

Stop on bounce.

stopOnUnsubscribeboolean

Stop on unsubscribe.

trackOpensboolean

Track opens.

trackClicksboolean

Track clicks.

opt_out_style'link' | 'reply' nullable

This applies to THIS campaign only — useful when one campaign writes to people in a different language from the rest of your outreach. Leave it out and the campaign keeps using your workspace setting; send null (or an empty string) to go back to following it. The choice itself works the same way it does for your workspace: How people opt out of your cold email. "link": The footer carries an Unsubscribe link — on your own verified tracking domain when you have one, otherwise on a shared WarmySender domain. "reply": The footer reads “Reply "unsubscribe" to opt out” and points back at the sending mailbox — no third-party link at all. Either way, a reply asking to unsubscribe is honored automatically and that person is never contacted again. Writing your own sentence? Put the word in quotes — like Reply “stop” — and a reply of just that word is honored too.

opt_out_textstring nullable

This applies to THIS campaign only — useful when one campaign writes to people in a different language from the rest of your outreach. Leave it out and the campaign keeps using your workspace setting; send null (or an empty string) to go back to following it. The wording rules are the same as your workspace setting: The sentence recipients click or reply to in order to opt out — written in your own words, 4–120 characters, one line. Send an empty string to go back to the default for your opt-out style ("Unsubscribe" for link, "Reply "unsubscribe" to opt out" for reply). Put {{opt_out}} inside an email or signature to place the sentence yourself.

company_addressstring nullable

The postal address shown in the footer of THIS campaign's emails — useful when you run campaigns for several companies from one workspace. Leave it out and the campaign keeps using your workspace address; send null (or an empty string) to go back to it.

startDatestring date-time nullable

Scheduled start, or null.

endDatestring date-time nullable

End date, or null.

Response

Success

Changes

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