Skip to main content

Update a notification channel

PATCH 
/api/v1/orgs/{orgId}/notifications/channels/{channelId}

Update channel configuration (partial update supported).

Parameters

  • channelId (string, required): Channel ID returned when the channel was created

Request Body

All fields are optional. Only provided fields are updated.

The channel type cannot be changed after the channel is created. A channelType value in the request is ignored. To use another type, delete the channel and create a new one. The new channel has a new channelId, so update the Alert Policies that use the old one.

  • name (string): Channel name.
  • description (string): Channel description.
  • isEnabled (boolean): Enable or disable the channel.
  • commonSettings (object): timeout in seconds (1 to 300), retryAttempts (0 to 10), retryDelay in milliseconds (0 to 30000).
  • config (object): Channel-type-specific configuration (same structure as create).
  • templateId (string): Template identifier. Sending null keeps the current template. To remove a channel's default template, delete the channel and create a new one without templateId.
  • recipients (array): Default recipients.
  • tags (array): Tags for categorization.

Responses

  • 200 OK: Channel updated successfully.
  • 404 Not Found: Channel not found.
  • 400 Bad Request: Validation error.
  • 503 Service Unavailable: Channel validation failed.

Request​

Responses​

Channel updated successfully