---
title: "CreateInvitation"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: EZGH Cloud organizations and IAM › invitations

`POST /v1/organizations/{orgId}/invitations`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie
- `oauth`, http, header `Authorization`

## Path parameters

- `CreateInvitation.path.orgId` (string, required)

## Header parameters

- `CreateInvitation.header.idempotency-key` (string, optional)

## Request body

_Required._

- `CreateInvitation.email` (string, required)
- `CreateInvitation.groupIds` (array<string>, optional)
- `CreateInvitation.policyIds` (array<string>, optional)
- `CreateInvitation.expiresInDays` (integer, optional)
  - min 1; max 30

## Example request

```json
{
  "email": "string",
  "groupIds": [
    "string"
  ],
  "policyIds": [
    "string"
  ],
  "expiresInDays": 1
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://orgs.ezghcloud.com/v1/organizations/string/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "string",
  "groupIds": [
    "string"
  ],
  "policyIds": [
    "string"
  ],
  "expiresInDays": 1
}
'
```

### TypeScript

```typescript
const url = 'https://orgs.ezghcloud.com/v1/organizations/string/invitations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({email: 'string', groupIds: ['string'], policyIds: ['string'], expiresInDays: 1})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://orgs.ezghcloud.com/v1/organizations/string/invitations"

payload = {
    "email": "string",
    "groupIds": ["string"],
    "policyIds": ["string"],
    "expiresInDays": 1
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

Success

#### Example

```json
{
  "id": "string",
  "organizationId": "string",
  "email": "string",
  "groupIds": [
    "string"
  ],
  "policyIds": [
    "string"
  ],
  "status": "pending",
  "url": "string",
  "invitedBy": "string",
  "createdAt": "string",
  "expiresAt": "string",
  "respondedAt": "string"
}
```

- `CreateInvitation.response.201.id` (string, required)
- `CreateInvitation.response.201.organizationId` (string, required)
- `CreateInvitation.response.201.email` (string, required)
- `CreateInvitation.response.201.groupIds` (array<string>, required)
- `CreateInvitation.response.201.policyIds` (array<string>, required)
- `CreateInvitation.response.201.status` (string, required)
  - one of `"pending"`, `"accepted"`, `"declined"`, `"revoked"`, `"expired"`
- `CreateInvitation.response.201.url` (string, required)
- `CreateInvitation.response.201.invitedBy` (string, required)
- `CreateInvitation.response.201.createdAt` (string, required)
- `CreateInvitation.response.201.expiresAt` (string, required)
- `CreateInvitation.response.201.respondedAt` (any of, required)
  - any of: `string`, `null`

### 400

InvalidRequest

#### Example

```json
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}
```

- `CreateInvitation.response.400.error` (object, required)
  - `CreateInvitation.response.400.error.code` (string, required)
    - one of `"invalid_request"`
  - `CreateInvitation.response.400.error.message` (string, required)
  - `CreateInvitation.response.400.error.issues` (array<object>, optional)
    - `CreateInvitation.response.400.error.issues.path` (string, required)
    - `CreateInvitation.response.400.error.issues.message` (string, required)

### 401

Unauthenticated

#### Example

```json
{
  "error": {
    "code": "unauthenticated",
    "message": "string"
  }
}
```

- `CreateInvitation.response.401.error` (object, required)
  - `CreateInvitation.response.401.error.code` (string, required)
    - one of `"unauthenticated"`
  - `CreateInvitation.response.401.error.message` (string, required)

### 403

AccessDenied | ForbiddenOrigin

#### Example

```json
{
  "error": {
    "code": "access_denied",
    "message": "string"
  }
}
```

Any of:

- [AccessDeniedEncoded](/orgs-api/schemas/AccessDeniedEncoded/)
- [ForbiddenOriginEncoded](/orgs-api/schemas/ForbiddenOriginEncoded/)

### 404

NotFound

#### Example

```json
{
  "error": {
    "code": "not_found",
    "message": "string"
  }
}
```

- `CreateInvitation.response.404.error` (object, required)
  - `CreateInvitation.response.404.error.code` (string, required)
    - one of `"not_found"`
  - `CreateInvitation.response.404.error.message` (string, required)

### 409

InvitationConflict | ManagedByScim | IdempotencyConflict | IdempotencyInProgress

#### Example

```json
{
  "error": {
    "code": "invitation_exists",
    "message": "string"
  }
}
```

Any of:

- [InvitationConflictEncoded](/orgs-api/schemas/InvitationConflictEncoded/)
- [ManagedByScimEncoded](/orgs-api/schemas/ManagedByScimEncoded/)
- [IdempotencyConflictEncoded](/orgs-api/schemas/IdempotencyConflictEncoded/)
- [IdempotencyInProgressEncoded](/orgs-api/schemas/IdempotencyInProgressEncoded/)

### 429

TooManyRequests

#### Example

```json
{
  "error": {
    "code": "too_many_requests",
    "message": "string"
  }
}
```

- `CreateInvitation.response.429.error` (object, required)
  - `CreateInvitation.response.429.error.code` (string, required)
    - one of `"too_many_requests"`
  - `CreateInvitation.response.429.error.message` (string, required)

### 500

InternalError

#### Example

```json
{
  "error": {
    "code": "internal_error",
    "message": "string"
  }
}
```

- `CreateInvitation.response.500.error` (object, required)
  - `CreateInvitation.response.500.error.code` (string, required)
    - one of `"internal_error"`
  - `CreateInvitation.response.500.error.message` (string, required)

### 503

Unavailable

#### Example

```json
{
  "error": {
    "code": "unavailable",
    "message": "string"
  }
}
```

- `CreateInvitation.response.503.error` (object, required)
  - `CreateInvitation.response.503.error.code` (string, required)
    - one of `"unavailable"`
  - `CreateInvitation.response.503.error.message` (string, required)


Source: https://docs.ezghcloud.com/orgs-api/invitations/CreateInvitation/index.md