Workspace

Update the cold email footer settings

Change the postal address printed in the footer of your cold email, the way people opt out, the wording of the opt-out sentence, your workspace timezone, or any combination. Send at least one field; anything you leave out is unchanged. This sends nothing and changes no sending limit.

Required scope: campaigns:write.

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.

Sending an empty string for company_address clears the address.

Sending an empty string for opt_out_text goes back to the default for your style ("Unsubscribe" for link, "Reply "unsubscribe" to opt out" for reply).

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

patch/workspace/settings

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/workspace/settings
  • Auth: HTTP bearer

Request body

company_addressstring

The postal address shown in the footer of your cold email. Send an empty string to clear it.

opt_out_style'link' | 'reply'

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

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.

timezonestring

Your workspace timezone, as a name like "Europe/Paris" or "America/New_York". Every new campaign starts with this timezone for its sending hours unless you give it a different one. Changing it does not move campaigns you already created — each keeps its own timezone.

Response

Success

Changes

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