# EventsCouponsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventCouponTier**](#addeventcoupontier) | **POST** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Add tier to event coupon|
|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create an event coupon|
|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create variant coupons from a parent coupon|
|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete an event coupon|
|[**deleteEventCouponVariants**](#deleteeventcouponvariants) | **DELETE** /events/{eventId}/coupons/{couponId}/variants | Delete all variants of a coupon|
|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get a single event coupon|
|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes | List purchases made with a coupon|
|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments | List payments made with a coupon|
|[**getEventCouponTiers**](#geteventcoupontiers) | **GET** /events/{eventId}/coupons/{couponId}/tiers | List event coupon tiers|
|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants | List a coupon\'s variants|
|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons | List an event\'s coupons|
|[**removeEventCouponTier**](#removeeventcoupontier) | **DELETE** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Remove tier from event coupon|
|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync a coupon\'s fields to its variants|
|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update an event coupon|

# **addEventCouponTier**
> CreateEventCoupon200Response addEventCouponTier(addEventAddOnTierRequest)

Adds a ticket tier to an event coupon\'s allow-list or disallow-list; when allowed is true the tier is connected to the coupon\'s allowed tiers, otherwise to its disallowed tiers. Requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)
let addEventAddOnTierRequest: AddEventAddOnTierRequest; //

const { status, data } = await apiInstance.addEventCouponTier(
    eventId,
    couponId,
    tierId,
    addEventAddOnTierRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addEventAddOnTierRequest** | **AddEventAddOnTierRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|


### Return type

**CreateEventCoupon200Response**

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

# **createEventCoupon**
> CreateEventCoupon200Response createEventCoupon(eventCouponCreateInputs)

Creates a new discount coupon for the given event and requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventCoupon200Response**

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

# **createEventCouponVariants**
> CreateEventCouponVariants200Response createEventCouponVariants(eventVariantCouponCreateInputs)

Generates the given quantity of unique, randomly-coded variant coupons cloned from a parent coupon\'s settings, failing if the parent is itself a variant or is pre-paid; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (default to undefined)
let eventVariantCouponCreateInputs: EventVariantCouponCreateInputs; //

const { status, data } = await apiInstance.createEventCouponVariants(
    eventId,
    couponId,
    eventVariantCouponCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventCouponVariants200Response**

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

# **deleteEventCoupon**
> CreateAccountInvitations200Response deleteEventCoupon()

Permanently deletes a coupon from an event, failing if any purchases have already used the coupon; requires update permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon 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)

# **deleteEventCouponVariants**
> CreateAccountInvitations200Response deleteEventCouponVariants()

Deletes every variant coupon generated from a parent coupon, failing if the target is itself a variant or if any variant has already been used in a purchase; requires update permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon 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)

# **getEventCoupon**
> CreateEventCoupon200Response getEventCoupon()

Retrieves the details of one coupon (by ID or code) for the given event, including its discount configuration and pre-paid/group settings; requires \"read\" permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventCoupon200Response**

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

# **getEventCouponPasses**
> GetEventAddOnPasses200Response getEventCouponPasses()

Returns a paginated list of pass purchases made using the given coupon (or any of its variants) on the event, supporting search by attendee name/email or purchase ID; requires \"read\" permission on both events and attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (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.getEventCouponPasses(
    eventId,
    couponId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon identifier | 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

**GetEventAddOnPasses200Response**

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

# **getEventCouponPayments**
> GetAccountPayments200Response getEventCouponPayments()

Returns a paginated list of payments on the given event that used the specified coupon, supporting search and `orderBy` sorting; requires \"read\" permission on both events and payments.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (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.getEventCouponPayments(
    eventId,
    couponId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon identifier | 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

**GetAccountPayments200Response**

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

# **getEventCouponTiers**
> GetAccountTiers200Response getEventCouponTiers()

Lists the ticket tiers currently on an event coupon\'s allow-list or disallow-list; the allowed flag selects which list to return (allowed tiers when true, disallowed tiers when false), with pagination, ordering, and search support.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (default to undefined)
let allowed: boolean; //Filter by allowed (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.getEventCouponTiers(
    eventId,
    couponId,
    allowed,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
| **allowed** | [**boolean**] | Filter by allowed | 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

**GetAccountTiers200Response**

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

# **getEventCouponVariants**
> GetEventCoupons200Response getEventCouponVariants()

Returns a paginated list of the child coupon variants belonging to the given parent coupon on the event, supporting search and `orderBy` sorting; requires \"read\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let parentCouponId: string; //The parentCoupon identifier (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.getEventCouponVariants(
    eventId,
    parentCouponId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **parentCouponId** | [**string**] | The parentCoupon identifier | 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

**GetEventCoupons200Response**

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

# **getEventCoupons**
> GetEventCoupons200Response getEventCoupons()

Returns a paginated list of coupons for the given event, filterable by `prePaid` (group-paid vs. standard coupons) and by `includeVariants` to include child coupon variants, with search and `orderBy` sorting; requires \"read\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let prePaid: boolean; //Filter by prePaid (optional) (default to undefined)
let includeVariants: object; //Filter by includeVariants (optional) (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.getEventCoupons(
    eventId,
    prePaid,
    includeVariants,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **prePaid** | [**boolean**] | Filter by prePaid | (optional) defaults to undefined|
| **includeVariants** | **object** | Filter by includeVariants | (optional) 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

**GetEventCoupons200Response**

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

# **removeEventCouponTier**
> CreateEventCoupon200Response removeEventCouponTier()

Removes a ticket tier from an event coupon\'s allow-list or disallow-list; the allowed query flag selects which list to disconnect the tier from (allowed tiers when true, disallowed tiers when false). Requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)
let allowed: boolean; //Filter by allowed (default to undefined)

const { status, data } = await apiInstance.removeEventCouponTier(
    eventId,
    couponId,
    tierId,
    allowed
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|


### Return type

**CreateEventCoupon200Response**

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

# **syncEventCouponToVariants**
> CreateEventCoupon200Response syncEventCouponToVariants(eventVariantCouponSyncInputs)

Copies the given list of field values from a parent coupon onto all of its variant coupons, failing if the target is itself a variant; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (default to undefined)
let eventVariantCouponSyncInputs: EventVariantCouponSyncInputs; //

const { status, data } = await apiInstance.syncEventCouponToVariants(
    eventId,
    couponId,
    eventVariantCouponSyncInputs
);
```

### Parameters

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


### Return type

**CreateEventCoupon200Response**

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

# **updateEventCoupon**
> CreateEventCoupon200Response updateEventCoupon(eventCouponUpdateInputs)

Updates the properties of an existing coupon on an event, such as its discount, active state, dates, and usage limits, blocking changes to the purchase limit on pre-paid coupons; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let couponId: string; //The coupon identifier (default to undefined)
let eventCouponUpdateInputs: EventCouponUpdateInputs; //

const { status, data } = await apiInstance.updateEventCoupon(
    eventId,
    couponId,
    eventCouponUpdateInputs
);
```

### Parameters

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


### Return type

**CreateEventCoupon200Response**

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