# EventsFollowupsTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventFollowupTranslation**](#deleteeventfollowuptranslation) | **DELETE** /events/{eventId}/followups/{followupId}/translations/{locale} | Delete a followup\'s translation|
|[**getEventFollowupTranslation**](#geteventfollowuptranslation) | **GET** /events/{eventId}/followups/{followupId}/translations/{locale} | Get a followup\'s translation for a locale|
|[**getEventFollowupTranslations**](#geteventfollowuptranslations) | **GET** /events/{eventId}/followups/{followupId}/translations | List a followup\'s translations|
|[**updateEventFollowupTranslation**](#updateeventfollowuptranslation) | **PUT** /events/{eventId}/followups/{followupId}/translations/{locale} | Update an event followup\'s translation|

# **deleteEventFollowupTranslation**
> SyncAccounts200Response deleteEventFollowupTranslation()

Permanently removes the translated content for a specific locale on an event registration followup message; requires the \"update\" permission on events.

### Example

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

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

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

const { status, data } = await apiInstance.deleteEventFollowupTranslation(
    eventId,
    followupId,
    locale
);
```

### Parameters

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

# **getEventFollowupTranslation**
> GetEventFollowupTranslation200Response getEventFollowupTranslation()

Returns the translated content for a single event registration followup in the given locale, or null if no translation exists; requires read permission on events.

### Example

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

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

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

const { status, data } = await apiInstance.getEventFollowupTranslation(
    eventId,
    followupId,
    locale
);
```

### Parameters

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


### Return type

**GetEventFollowupTranslation200Response**

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

# **getEventFollowupTranslations**
> GetEventFollowupTranslations200Response getEventFollowupTranslations()

Returns a paginated list of locale translations for the given event registration followup, supporting search and ordering; requires read permission on events.

### Example

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

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

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

### Parameters

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

**GetEventFollowupTranslations200Response**

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

# **updateEventFollowupTranslation**
> SyncAccounts200Response updateEventFollowupTranslation(eventFollowupTranslationUpdateInputs)

Updates the localized content (for the given locale) of a registration followup on an event, requires \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let followupId: string; //The followup identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventFollowupTranslationUpdateInputs: EventFollowupTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventFollowupTranslation(
    eventId,
    followupId,
    locale,
    eventFollowupTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventFollowupTranslationUpdateInputs** | **EventFollowupTranslationUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **followupId** | [**string**] | The followup identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


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