Replace sender

Replaces the org's sender and answers it.

PUT /v1/marketing/sender

Marketing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/marketing/sender`
Method	`PUT`
Operation	`put_marketing_sender`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Replaces the org's sender and answers it. Every field is written; one left out is cleared.

Org admin only.

Request

7 fields, body application/json (required).

Field	In	Type	Required	Description
`company`	body	string	—	Company is the sender's legal name in the footer.
`fromAddress`	body	string	—	FromAddress is the sender's address.
`fromName`	body	string	—	FromName is the sender's name.
`postal`	body	string	—	Postal is the sender's physical postal address (CAN-SPAM).
`provider`	body	string	—	Provider is ses or sendgrid; empty takes the platform's default.
`replyTo`	body	string	—	ReplyTo is where replies go.
`site`	body	string	—	Site is the org's public site, as a host name ("acme.com"), which serves /newsletter/confirm and /newsletter/preferences: the pages a confirmation link and a preference link open.

Response

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

200 body — 7 fields.

Field	In	Type	Always	Description
`company`	body	string	—	Company is the sender's legal name in the footer.
`fromAddress`	body	string	—	FromAddress is the sender's address.
`fromName`	body	string	—	FromName is the sender's name.
`postal`	body	string	—	Postal is the sender's physical postal address (CAN-SPAM).
`provider`	body	string	—	Provider is ses or sendgrid; empty takes the platform's default.
`replyTo`	body	string	—	ReplyTo is where replies go.
`site`	body	string	—	Site is the org's public site, as a host name ("acme.com"), which serves /newsletter/confirm and /newsletter/preferences: the pages a confirmation link and a preference link open.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo marketing sender replace

.ts

.py

.go

.rs

.java

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putMarketingSender({ company: "<company>", fromAddress: "<fromAddress>" });

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).put_marketing_sender(company="<company>", from_address="<fromAddress>")

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

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

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::put_marketing_sender(&cfg, Default::default()).await?;

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).putMarketingSender();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (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 →

curl -X PUT https://api.hanzo.ai/v1/marketing/sender \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "company": "<company>",
       "fromAddress": "<fromAddress>"
     }'

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:

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 · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousReplace segments NextDelete listings