# Update lists

URL: https://docs.hanzo.ai/docs/openapi/marketing/patch-marketing-lists-by-id

> Changes the fields the body names on one of the org's lists and answers the list.

`PATCH /v1/marketing/lists/{id}`

> [Marketing →](https://docs.hanzo.ai/docs/openapi/marketing) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                |
| ------------- | ---------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/marketing/lists/{id}` |
| **Method**    | `PATCH`                                        |
| **Operation** | `patch_marketing_lists_by_id`                  |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`         |

Changes the fields the body names on one of the org's lists and
answers the list. A field left out keeps its value; an empty string clears a
sender field back to the org's.

Org admin only.

## Request

15 fields, body `application/json` (required).

| Field         | In   | Type    | Required | Description                                                                                       |
| ------------- | ---- | ------- | -------- | ------------------------------------------------------------------------------------------------- |
| `id`          | path | string  | yes      | ID is the list to change, from the path; ignored on create.                                       |
| `company`     | body | string  | —        | Company is the sender's legal name in the footer; at most 200 characters.                         |
| `description` | body | string  | —        | Description says what subscribers receive; at most 2000 characters.                               |
| `doubleOptIn` | body | boolean | —        | DoubleOptIn is whether a public subscription must be confirmed; a new list asks for confirmation. |
| `footer`      | body | string  | —        | Footer is text closing every mail of the list; at most 2000 characters.                           |
| `fromAddress` | body | string  | —        | FromAddress is the sender's address.                                                              |
| `fromName`    | body | string  | —        | FromName is the sender's name; at most 200 characters.                                            |
| `id`          | body | string  | —        | ID is the list to change, from the path; ignored on create.                                       |
| `language`    | body | string  | —        | Language is a BCP 47 tag; a new list takes the platform's default.                                |
| `name`        | body | string  | —        | Name is what the list is called.                                                                  |
| `postal`      | body | string  | —        | Postal is the sender's physical postal address; at most 500 characters.                           |
| `provider`    | body | string  | —        | Provider is ses, sendgrid, or empty for the org's own.                                            |
| `replyTo`     | body | string  | —        | ReplyTo is where replies go.                                                                      |
| `slug`        | body | string  | —        | Slug is the list's name in a URL: lower-case letters, digits and hyphens, at most 63.             |
| `visibility`  | body | string  | —        | Visibility is public or private; a new list is private.                                           |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | marketing.List  | ok      |
| `default` | problem-details | refused |

`200` body — 18 fields.

| Field         | In   | Type            | Always | Description                                                                                                                      |
| ------------- | ---- | --------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `company`     | body | string          | —      | Company is the sender's legal name in the footer; empty takes the org's.                                                         |
| `counts`      | body | object          | —      | Counts are the list's subscribers by status.                                                                                     |
| `counts.*`    | body | integer (int64) | —      |                                                                                                                                  |
| `createdAt`   | body | integer (int64) | —      | CreatedAt is when the list was created, unix seconds.                                                                            |
| `description` | body | string          | —      | Description says what subscribers receive.                                                                                       |
| `doubleOptIn` | body | boolean         | —      | DoubleOptIn is whether a public subscription waits for the address to confirm before it is subscribed.                           |
| `footer`      | body | string          | —      | Footer is text closing every mail of the list, above the unsubscribe line.                                                       |
| `fromAddress` | body | string          | —      | FromAddress is the sender's address; empty takes the org's.                                                                      |
| `fromName`    | body | string          | —      | FromName is the sender's name on the list's mail; empty takes the org's.                                                         |
| `id`          | body | string          | —      | ID is the list's id ("lst\_" and 96 random bits in hex).                                                                         |
| `language`    | body | string          | —      | Language is the list's language, a BCP 47 tag.                                                                                   |
| `name`        | body | string          | —      | Name is what the list is called.                                                                                                 |
| `postal`      | body | string          | —      | Postal is the sender's physical postal address, which every commercial mail carries (CAN-SPAM); empty takes the org's.           |
| `provider`    | body | string          | —      | Provider is ses or sendgrid; empty takes the org's.                                                                              |
| `replyTo`     | body | string          | —      | ReplyTo is where replies go; empty takes the org's.                                                                              |
| `slug`        | body | string          | —      | Slug is the list's name in a URL, unique in the org: a public form may name the list by it ("newsletter").                       |
| `updatedAt`   | body | integer (int64) | —      | UpdatedAt is the last change to the list itself, unix seconds.                                                                   |
| `visibility`  | body | string          | —      | Visibility is public, which the public subscribe and the preference page offer, or private, which only the org's own calls fill. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo marketing lists update <id>
```

**SDK**

**.ts**

```ts
import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchMarketingListsById({ id: 'id', company: "<company>", description: "<description>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).patch_marketing_lists_by_id(id='id', company="<company>", description="<description>")
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.PatchMarketingListsById(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, marketing_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = marketing_api::patch_marketing_lists_by_id(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MarketingApi(client).patchMarketingListsById();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl -X PATCH https://api.hanzo.ai/v1/marketing/lists/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "company": "<company>",
       "description": "<description>"
     }'
```

**MCP**

MCP reaches **marketing** through the `marketing` tool, which names its 82 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_marketing_audiences"
         }
       }
     }'
```

---

[Marketing API](https://docs.hanzo.ai/docs/openapi/marketing) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
