List sender

Returns the org's sender: the provider and the from, reply and footer fields every list takes when it leaves its own empty.

GET /v1/marketing/sender

Addresshttps://api.hanzo.ai/v1/marketing/sender
MethodGET
Operationget_marketing_sender
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the org's sender: the provider and the from, reply and footer fields every list takes when it leaves its own empty.

Request

GET /v1/marketing/sender takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200marketing.Senderok
defaultproblem-detailsrefused

200 body — 7 fields.

FieldInTypeAlwaysDescription
companybodystring—Company is the sender's legal name in the footer.
fromAddressbodystring—FromAddress is the sender's address.
fromNamebodystring—FromName is the sender's name.
postalbodystring—Postal is the sender's physical postal address (CAN-SPAM).
providerbodystring—Provider is ses or sendgrid; empty takes the platform's default.
replyTobodystring—ReplyTo is where replies go.
sitebodystring—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

hanzo marketing sender get
import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingSender();
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).get_marketing_sender()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.GetMarketingSender(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::get_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).getMarketingSender();

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 https://api.hanzo.ai/v1/marketing/sender \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool marketing, op get_marketing_sender — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "marketing",
         "arguments": {
           "op": "get_marketing_sender",
           "input": {}
         }
       }
     }'

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.