# Create invitations

URL: https://docs.hanzo.ai/docs/openapi/iam/post-iam-invitations

> Issues an invitation to join your organization — the code or link a new member redeems, with the role they arrive holding and the date it stops working.

`POST /v1/iam/invitations`

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

|               |                                           |
| ------------- | ----------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/iam/invitations` |
| **Method**    | `POST`                                    |
| **Operation** | `post_iam_invitations`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`    |

Issues an invitation to join your organization — the code or link a new
member redeems, with the role they arrive holding and the date it stops
working. A name already used in the organization is refused.

## Request

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

| Field         | In   | Type            | Required | Description |
| ------------- | ---- | --------------- | -------- | ----------- |
| `application` | body | string          | —        |             |
| `code`        | body | string          | —        |             |
| `createdTime` | body | string          | —        |             |
| `defaultCode` | body | string          | —        |             |
| `displayName` | body | string          | —        |             |
| `email`       | body | string          | —        |             |
| `isRegexp`    | body | boolean         | —        |             |
| `name`        | body | string          | —        |             |
| `owner`       | body | string          | —        |             |
| `phone`       | body | string          | —        |             |
| `quota`       | body | integer (int64) | —        |             |
| `signupGroup` | body | string          | —        |             |
| `state`       | body | string          | —        |             |
| `updatedTime` | body | string          | —        |             |
| `usedCount`   | body | integer (int64) | —        |             |
| `username`    | body | string          | —        |             |

## Response

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

`200` body — 22 fields.

| Field         | In   | Type               | Always | Description                                                                                                   |
| ------------- | ---- | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------- |
| `application` | body | string             | —      |                                                                                                               |
| `code`        | body | string             | —      |                                                                                                               |
| `createdAt`   | body | string (date-time) | —      |                                                                                                               |
| `createdTime` | body | string             | —      |                                                                                                               |
| `defaultCode` | body | string             | —      |                                                                                                               |
| `deleted`     | body | boolean            | —      |                                                                                                               |
| `displayName` | body | string             | —      |                                                                                                               |
| `email`       | body | string             | —      |                                                                                                               |
| `generated`   | body | boolean            | —      | Generated reports that IAM minted Code itself, from crypto/rand, when the invitation was created.             |
| `id`          | body | string             | —      |                                                                                                               |
| `isRegexp`    | body | boolean            | —      |                                                                                                               |
| `name`        | body | string             | —      |                                                                                                               |
| `owner`       | body | string             | —      |                                                                                                               |
| `phone`       | body | string             | —      |                                                                                                               |
| `quota`       | body | integer (int64)    | —      |                                                                                                               |
| `sentTime`    | body | string             | —      | SentTime is when an email about this invitation last went to its pinned address (RFC 3339), "" when none has. |
| `signupGroup` | body | string             | —      |                                                                                                               |
| `state`       | body | string             | —      |                                                                                                               |
| `updatedAt`   | body | string (date-time) | —      |                                                                                                               |
| `updatedTime` | body | string             | —      |                                                                                                               |
| `usedCount`   | body | integer (int64)    | —      |                                                                                                               |
| `username`    | body | string             | —      |                                                                                                               |

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

## Examples

**CLI**

```bash
hanzo iam invitations create
```

**SDK**

**.ts**

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

const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postIamInvitations({ application: "<application>", code: "<code>" });
```

**.py**

```python
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(application="<application>", code="<code>")
```

**.go**

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

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

**.rs**

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

**.java**

```java
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).postIamInvitations();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/iam/invitations \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "application": "<application>",
       "code": "<code>"
     }'
```

**MCP**

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:

```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_iam_applications"
         }
       }
     }'
```

---

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