# Creates and deploys a new announcement to targeted computers or users

Creates and deploys a new announcement with the specified message, schedule window (start time, end time, lap time), platform, and target computers or groups. Accepts a JSON body with the full announcement collection configuration.

## Endpoint

`POST /dcapi/tools/announcement/deploy`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/tools/announcement/deploy`

### Scope

`Tools.UPDATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

| Header | Type | Required | Value |
|---|---|---|---|
| Accept | string | Mandatory | `application/announcementDeployStatus.v1+json` |
| Content-Type | string | Mandatory | `application/announcementCollectionDetails.v1+json` |

#### Request Body

`application/json`

- JSON Object
  - `label` — string, **Mandatory**
  - `deployAction` — string, Optional
  - `isModify` — boolean, Optional
  - `isImageAnnouncement` — boolean, Optional
  - `imageIDs` — JSON Array, Optional
  - `deleteImages` — JSON Array, Optional
  - `collectionID` — string, Optional
    - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/announcement-deploy-announcement.html?getRoles)
  - `targetDetails` — JSON Object, Optional
    - `targetType` — string, Optional
    - `targetValue` — string, Optional
    - `envType` — string, Optional
  - `configDetails` — JSON Array, Optional
    - JSON Object
      - `configName` — string, **Mandatory**
  - `configType` — string, Optional

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/tools/announcement/deploy \
  --header 'Accept: application/announcementDeployStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/announcementCollectionDetails.v1+json' \
  --data '{"deployAction":"Deploy","configDetails":[{"toolDetails":{"repeatFrequency":1,"repeatDuration":600,"startTime":"22:00","endTime":"02:00","message":"System maintenance tonight from 11 PM to 2 AM."}}],"label":"Maintenance Window Notice","isModify":false,"configType":"Computer","collectionID":0,"targetDetails":{"envType":0,"targetValue":"Engineering","targetType":"CustomGroup"}}'
```

### Sample Request Body

```json
{
  "deployAction": "Deploy",
  "configDetails": [
    {
      "toolDetails": {
        "repeatFrequency": 1,
        "repeatDuration": 600,
        "startTime": "22:00",
        "endTime": "02:00",
        "message": "System maintenance tonight from 11 PM to 2 AM."
      }
    }
  ],
  "label": "Maintenance Window Notice",
  "isModify": false,
  "configType": "Computer",
  "collectionID": 0,
  "targetDetails": {
    "envType": 0,
    "targetValue": "Engineering",
    "targetType": "CustomGroup"
  }
}
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body — `application/json`

- JSON Object
  - `status` — string
    - Result of the create or update operation: success or failure
  - `collectionId` — long
    - Unique identifier of the created or updated task collection

### Possible Response Codes

| Code | Description |
|---|---|
| 200 | HTTP code |

### Sample Response: HTTP 200

```json
{
  "collectionId": 7,
  "status": "success"
}
```

## Rate Limits

**Duration:** 1 minute | **Threshold:** 30 | **Lock period:** 5 minutes

Duration - Time window for the threshold.  
Threshold - Number of API calls allowed within the specified duration.  
Lock Period - Wait time before consecutive API requests.