# OrganizationLanguageoverridesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteOrganizationLanguageOverride**](#deleteorganizationlanguageoverride) | **DELETE** /organization/language-overrides | Delete a language override|
|[**getOrganizationLanguageOverrides**](#getorganizationlanguageoverrides) | **GET** /organization/language-overrides | List an organization\'s language overrides|
|[**upsertOrganizationLanguageOverride**](#upsertorganizationlanguageoverride) | **PUT** /organization/language-overrides | Create or update a language override|

# **deleteOrganizationLanguageOverride**
> SyncAccounts200Response deleteOrganizationLanguageOverride()

Deletes the organization\'s i18n string override for the given key across all locales (key sent as a query parameter since keys can contain spaces), requires the update org permission, and refreshes the language overrides list on success.

### Example

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

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

let key: string; //Filter by key (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **key** | [**string**] | Filter by key | defaults to undefined|


### Return type

**SyncAccounts200Response**

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

# **getOrganizationLanguageOverrides**
> GetOrganizationLanguageOverrides200Response getOrganizationLanguageOverrides()

Returns a paginated list of the organization\'s i18n string overrides grouped by key, each with its per-locale values; searchable by key. Requires org read permission.

### Example

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

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

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.getOrganizationLanguageOverrides(
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **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

**GetOrganizationLanguageOverrides200Response**

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

# **upsertOrganizationLanguageOverride**
> SyncAccounts200Response upsertOrganizationLanguageOverride(organizationLanguageOverrideUpsertInputs)

Upserts the organization\'s i18n string override for a key across all supplied locale values in a single request, requires the update org permission, and refreshes the language overrides list on success.

### Example

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

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

let organizationLanguageOverrideUpsertInputs: OrganizationLanguageOverrideUpsertInputs; //

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationLanguageOverrideUpsertInputs** | **OrganizationLanguageOverrideUpsertInputs**|  | |


### Return type

**SyncAccounts200Response**

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