---
title: "Update the cold email footer settings"
method: PATCH
path: "/workspace/settings"
tags: ["Workspace"]
---

# Update the cold email footer settings

`PATCH /workspace/settings`

## Request

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

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.

## Request body

- object
  - `company_address` string: 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_text` string: 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.
  - `timezone` string: 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 `200`

Success

## Other responses

- `400`: `validation_error` — No field was supplied, an unknown field was sent, opt_out_style was not "link" or "reply", or opt_out_text was too short, too long, or worded in a way that would not read as an opt-out.
- `401`: `unauthorized` — Missing or invalid API key.
- `403`: `insufficient_scope` — The key lacks campaigns:write.
- `404`: `not_found` — The workspace no longer exists.
- `429`: `rate_limited` — Too many requests — slow down and retry after the Retry-After delay.

---

[API](https://skmtc.dev/warmysender/apis/warmysender-public-api.md) · [All operations](https://skmtc.dev/warmysender/apis/warmysender-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/warmysender/apis/warmysender-public-api/revisions/eb5c7f10a1cd?raw)