# GroupsInvitationsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**cancelGroupInvitation**](#cancelgroupinvitation) | **PUT** /groups/{groupId}/invitations/{invitationId}/cancel | Cancel a group invitation|
|[**createGroupInvitations**](#creategroupinvitations) | **POST** /groups/{groupId}/invitations | Invite accounts to join a group|
|[**deleteGroupInvitation**](#deletegroupinvitation) | **DELETE** /groups/{groupId}/invitations/{invitationId} | Permanently delete a group invitation|
|[**getGroupInvitation**](#getgroupinvitation) | **GET** /groups/{groupId}/invitations/{invitationId} | Get a single group invitation|
|[**getGroupInvitations**](#getgroupinvitations) | **GET** /groups/{groupId}/invitations | List a group\'s invitations|
|[**reinviteGroupInvitation**](#reinvitegroupinvitation) | **PUT** /groups/{groupId}/invitations/{invitationId}/reinvite | Reinvite a canceled group invitation|

# **cancelGroupInvitation**
> GetGroupInvitation200Response cancelGroupInvitation()

Marks a pending group invitation as canceled so the invited account can no longer accept it, requiring update permission on groups; the group\'s invitations list is invalidated.

### Example

```typescript
import {
    GroupsInvitationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new GroupsInvitationsApi(configuration);

let groupId: string; //The group identifier (default to undefined)
let invitationId: string; //The invitation identifier (default to undefined)

const { status, data } = await apiInstance.cancelGroupInvitation(
    groupId,
    invitationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **groupId** | [**string**] | The group identifier | defaults to undefined|
| **invitationId** | [**string**] | The invitation identifier | defaults to undefined|


### Return type

**GetGroupInvitation200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createGroupInvitations**
> CreateGroupInvitations200Response createGroupInvitations(createGroupInvitationsRequest)

Creates up to 10 pending invitations for the given account IDs to join a group on behalf of a moderator account, requiring update permission on groups; the group\'s invitations list is invalidated.

### Example

```typescript
import {
    GroupsInvitationsApi,
    Configuration,
    CreateGroupInvitationsRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new GroupsInvitationsApi(configuration);

let groupId: string; //The group identifier (default to undefined)
let createGroupInvitationsRequest: CreateGroupInvitationsRequest; //

const { status, data } = await apiInstance.createGroupInvitations(
    groupId,
    createGroupInvitationsRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **createGroupInvitationsRequest** | **CreateGroupInvitationsRequest**|  | |
| **groupId** | [**string**] | The group identifier | defaults to undefined|


### Return type

**CreateGroupInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteGroupInvitation**
> CreateAccountInvitations200Response deleteGroupInvitation()

Removes a group invitation record entirely, requiring update permission on groups; the group\'s invitations list is invalidated.

### Example

```typescript
import {
    GroupsInvitationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new GroupsInvitationsApi(configuration);

let groupId: string; //The group identifier (default to undefined)
let invitationId: string; //The invitation identifier (default to undefined)

const { status, data } = await apiInstance.deleteGroupInvitation(
    groupId,
    invitationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **groupId** | [**string**] | The group identifier | defaults to undefined|
| **invitationId** | [**string**] | The invitation identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getGroupInvitation**
> GetGroupInvitation200Response getGroupInvitation()

Returns the details of a single invitation to the given group by its invitation ID, including its status (invited, canceled, rejected, or accepted); requires \"read\" permission on groups.

### Example

```typescript
import {
    GroupsInvitationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new GroupsInvitationsApi(configuration);

let groupId: string; //The group identifier (default to undefined)
let invitationId: string; //The invitation identifier (default to undefined)

const { status, data } = await apiInstance.getGroupInvitation(
    groupId,
    invitationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **groupId** | [**string**] | The group identifier | defaults to undefined|
| **invitationId** | [**string**] | The invitation identifier | defaults to undefined|


### Return type

**GetGroupInvitation200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getGroupInvitations**
> GetGroupInvitations200Response getGroupInvitations()

Returns a paginated list of invitations sent for the given group, filterable by status (e.g. invited, canceled, rejected, accepted) and a search term, with sorting via orderBy; requires \"read\" permission on groups.

### Example

```typescript
import {
    GroupsInvitationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new GroupsInvitationsApi(configuration);

let groupId: string; //The group identifier (default to undefined)
let status: GroupInvitationStatus; //Filter by status (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getGroupInvitations(
    groupId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **groupId** | [**string**] | The group identifier | defaults to undefined|
| **status** | **GroupInvitationStatus** | Filter by status | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetGroupInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **reinviteGroupInvitation**
> GetGroupInvitation200Response reinviteGroupInvitation()

Restores a previously canceled group invitation back to invited status so the account can accept it again, requiring update permission on groups; the group\'s invitations list is invalidated.

### Example

```typescript
import {
    GroupsInvitationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new GroupsInvitationsApi(configuration);

let groupId: string; //The group identifier (default to undefined)
let invitationId: string; //The invitation identifier (default to undefined)

const { status, data } = await apiInstance.reinviteGroupInvitation(
    groupId,
    invitationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **groupId** | [**string**] | The group identifier | defaults to undefined|
| **invitationId** | [**string**] | The invitation identifier | defaults to undefined|


### Return type

**GetGroupInvitation200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)