Send invitations

Emails an invitation to the address it is pinned to: who invited them, to which organization, and the link that joins them.

POST /v1/iam/invitations/{owner}/{name}/send

IAM → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/iam/invitations/{owner}/{name}/send`
Method	`POST`
Operation	`post_iam_invitations_by_owner_by_name_send`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Emails an invitation to the address it is pinned to: who invited them, to which organization, and the link that joins them.

The caller chooses nothing about how it goes out. It is sent through the platform application the caller's access token was issued to, from that application's org's email account, with a link on the identity host that issued the token — the way the inviter came in. Only the pinned address receives it.

Request

3 fields.

Field	In	Type	Required
`owner`	path	string	yes
`name`	path	string	yes
`Authorization`	header	string	—

Response

Status	Body	Meaning
`200`	iam.SendOutput	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`sent`	body	boolean	—
`to`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

.ts

.py

.go

.rs

.java

import { Configuration, IamApi } from 'hanzoai';

const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postIamInvitationsByOwnerByNameSend({ owner: 'owner', name: 'name' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IamApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IamApi(client).post_iam_invitations_by_owner_by_name_send(owner='owner', name='name')

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

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

use hanzo_client::apis::{configuration::Configuration, iam_api};

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

let result = iam_api::post_iam_invitations_by_owner_by_name_send(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IamApi;

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

var result = new IamApi(client).postIamInvitationsByOwnerByNameSend();

curl -X POST https://api.hanzo.ai/v1/iam/invitations/<owner>/<name>/send \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches iam through the iam tool, which names its 44 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_iam_applications"
         }
       }
     }'

IAM API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate accept NextCreate invitations