---
title: "Update alert description"
method: PATCH
path: "/api/{cloudId}/v1/alerts/{id}/description"
tags: ["Alerts"]
---

# Update alert description

`PATCH /api/{cloudId}/v1/alerts/{id}/description`

This endpoint is used to update the description of an existing alert. This endpoint plays a crucial role in ensuring that team members have the most current details for incident response.

## Path parameters

- `id` string, required

## Request body

- UpdateAlertDescriptionRequest
  - `description` string — Detailed information contains more comprehensive information than the 'message' field, including the implications of the alert, steps to reproduce the issue, or suggestions for resolving the problem. It serves as a guide for the person or team responding to the alert to better understand the situation and take appropriate actions.

## Response `202`

Returned if the request is successful.

- SuccessResponse
  - `result` string — Indicates the outcome of the request.
  - `requestId` string — Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.
  - `took` integer

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `422` — Returned if the payload cannot be validated.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)