Replace provider

Sets the provider the org's mail leaves by when a send pins none: ses or sendgrid.

PUT /v1/email/provider

Addresshttps://api.hanzo.ai/v1/email/provider
MethodPUT
Operationput_email_provider
AuthAuthorization: Bearer $HANZO_API_KEY

Sets the provider the org's mail leaves by when a send pins none: ses or sendgrid. With none set it is SES, else SendGrid, whichever the org holds credentials for; a send that pins one goes by it. Org admin only, and on the audit trail (email.provider.set) before it takes effect.

PUT /v1/email/provider

Request

1 field, body application/json (required).

FieldInTypeRequiredDescription
providerbodystring—Provider is ses or sendgrid.

Response

StatusBodyMeaning
200email.Choiceok
defaultproblem-detailsrefused

200 body — 1 field.

FieldInTypeAlwaysDescription
providerbodystring—Provider is ses or sendgrid.

Failure carries the platform error shape — see Errors.

Examples

hanzo email provider
import { Configuration, EmailApi } from 'hanzoai';

const api = new EmailApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putEmailProvider({ provider: "<provider>" });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import EmailApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = EmailApi(client).put_email_provider(provider="<provider>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.EmailAPI.PutEmailProvider(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, email_api};

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

let result = email_api::put_email_provider(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.EmailApi;

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

var result = new EmailApi(client).putEmailProvider();

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/email/provider \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "provider": "<provider>"
     }'

MCP reaches email through the email tool, which names its 8 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_emails"
         }
       }
     }'

Email 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.