Notification Handlers: Update

This documentation entry provides a clear and detailed guide on how to update an existing notification handler using the API, including the necessary parameters, headers, and expected response.

Endpoint

POST /api/notification-handlers/{notification_handler_id}

Update an existing notification handler by specifying its unique identifier.

Request

HTTP Request

POST https://uptimekeep.com/api/notification-handlers/{notification_handler_id}

Replace {notification_handler_id} with the ID of the notification handler you wish to update.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.
Content-Type	String	Must be set to multipart/form-data for file uploads.

Parameters

Parameter	Type	Required	Description
name	String	No	Name of the notification handler.
type	String	No	Type of the notification handler. Allowed values: email, webhook, slack, discord, telegram, microsoft_teams, twilio, twilio_call.
email	String	No	Email address for notifications. Available when type = email.
webhook	String	No	Webhook URL for notifications. Available when type = webhook.
slack	String	No	Slack webhook URL for notifications. Available when type = slack.
discord	String	No	Discord webhook URL for notifications. Available when type = discord.
telegram	String	No	Telegram API Token for notifications. Available when type = telegram.
telegram_chat_id	String	No	Telegram Chat ID for notifications. Available when type = telegram.
twilio	String	No	Phone number for Twilio SMS notifications. Available when type = twilio.
is_enabled	Boolean	No	Enable or disable the notification handler.

Example of a request:

curl --request POST \
--url 'https://uptimekeep.com/api/notification-handlers/{notification_handler_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example new name' \
--form 'is_enabled=1'

Response

A successful response returns a JSON object containing the unique identifier of the updated notification handler.

Response Example

{
    "data": {
        "id": 1
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the updated notification handler.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 400 Bad Request if required parameters are missing or invalid, or 404 Not Found if the notification handler ID does not exist.