# PreferencesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getPreferences**](#getpreferences) | **GET** /preferences | Get the current user\'s notification preferences|
|[**updatePreferences**](#updatepreferences) | **PUT** /preferences | Update the current admin user\'s notification preferences|

# **getPreferences**
> GetPreferences200Response getPreferences()

Returns the calling admin user\'s support ticket notification preferences (in-app and email) for the current organization membership.

### Example

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

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

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

### Parameters
This endpoint does not have any parameters.


### Return type

**GetPreferences200Response**

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

# **updatePreferences**
> GetPreferences200Response updatePreferences(adminNotificationPreferencesUpdateInputs)

Updates the calling admin user\'s own support ticket notification settings (in-app and email toggles for new, assigned, and message-received tickets) for their organization membership.

### Example

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

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

let adminNotificationPreferencesUpdateInputs: AdminNotificationPreferencesUpdateInputs; //

const { status, data } = await apiInstance.updatePreferences(
    adminNotificationPreferencesUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **adminNotificationPreferencesUpdateInputs** | **AdminNotificationPreferencesUpdateInputs**|  | |


### Return type

**GetPreferences200Response**

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