# AnnouncementsScheduleApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**cancelAnnouncementSchedule**](#cancelannouncementschedule) | **DELETE** /announcements/{announcementId}/schedule | Cancel an announcement\'s scheduled send|
|[**updateAnnouncementSchedule**](#updateannouncementschedule) | **PUT** /announcements/{announcementId}/schedule | Schedule or reschedule an announcement send|

# **cancelAnnouncementSchedule**
> CreateAnnouncement200Response cancelAnnouncementSchedule()

Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.

### Example

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

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

let announcementId: string; //The announcement identifier (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **announcementId** | [**string**] | The announcement identifier | defaults to undefined|


### Return type

**CreateAnnouncement200Response**

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

# **updateAnnouncementSchedule**
> CreateAnnouncement200Response updateAnnouncementSchedule(body)

Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.

### Example

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

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

let announcementId: string; //The announcement identifier (default to undefined)
let body: object; //

const { status, data } = await apiInstance.updateAnnouncementSchedule(
    announcementId,
    body
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**|  | |
| **announcementId** | [**string**] | The announcement identifier | defaults to undefined|


### Return type

**CreateAnnouncement200Response**

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