# EventsGroupcouponreminderApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getEventGroupCouponReminder**](#geteventgroupcouponreminder) | **GET** /events/{eventId}/groupCouponReminder | Get an event\'s group coupon reminder schedule|
|[**updateEventGroupCouponReminder**](#updateeventgroupcouponreminder) | **PUT** /events/{eventId}/groupCouponReminder | Update an event\'s group coupon reminder schedule|

# **getEventGroupCouponReminder**
> GetEventGroupCouponReminder200Response getEventGroupCouponReminder()

Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)

const { status, data } = await apiInstance.getEventGroupCouponReminder(
    eventId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**GetEventGroupCouponReminder200Response**

### 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)

# **updateEventGroupCouponReminder**
> GetEventGroupCouponReminder200Response updateEventGroupCouponReminder(eventGroupCouponReminderUpdateInputs)

Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventGroupCouponReminderUpdateInputs: EventGroupCouponReminderUpdateInputs; //

const { status, data } = await apiInstance.updateEventGroupCouponReminder(
    eventId,
    eventGroupCouponReminderUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventGroupCouponReminderUpdateInputs** | **EventGroupCouponReminderUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**GetEventGroupCouponReminder200Response**

### 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)