Skip to main content
POST
Update channel

Restrictions

Usage

  • Omitted or null fields keep their current value. group, flapping and event_group each replace the whole stored object.
  • Pass managing_team_ids: [] to remove all managing teams.
  • auto_resolve_mode is applied only together with auto_resolve_timeout; when auto_resolve_timeout is sent without auto_resolve_mode, the mode resets to trigger.
  • Setting is_external_report_enabled to true generates a new external_report_token on every call and the previous token stops working; false clears the token.
  • A channel_name used by another channel returns InvalidParameter; group.method p or i without the matching license returns NoLicense.
  • The caller must also be able to edit the channel: the account owner or an admin, the channel creator, or a member of its managing teams (of its owning team when managing_team_ids is empty). Otherwise the call returns AccessDenied.
  • Every call is recorded in the account audit log.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for updating a channel. Only the fields you pass are updated.

channel_id
integer<int64>
required

ID of the channel to update; obtain it from POST /channel/list.

team_id
integer<int64> | null

New owning team ID; obtain it from POST /team/list. Must exist. Omit or pass null to keep the current team.

managing_team_ids
integer<int64>[]

Replaces the additional managing teams, up to 3; every ID must exist. Pass [] to remove them all; omit to keep the current list.

Maximum array length: 3
channel_name
string | null

New channel name, 1–59 characters, unique within the account. A changed name must not contain a comma or start or end with whitespace. Omit or pass null to keep the current name.

Required string length: 1 - 59
description
string | null

New description. Up to 500 characters.

Maximum string length: 500
auto_resolve_timeout
integer<int64> | null

Auto-resolve timeout in seconds. 0 disables auto-resolve. Max 30 days.

Required range: 0 <= x <= 2592000
auto_resolve_mode
enum<string>

How the auto-resolve timer runs: trigger starts it once when the incident is triggered, update restarts it whenever a new alert merges in. Applied only together with auto_resolve_timeout; if auto_resolve_timeout is sent without it, the mode resets to trigger.

Available options:
trigger,
update
is_private
boolean | null

When true, the channel is visible only to its managing teams.

group
object

Alert grouping configuration; replaces the stored configuration as a whole when present.

flapping
object

Flapping detection configuration; replaces the stored configuration as a whole when present.

disable_outlier_detection
boolean | null

Disable outlier incident detection.

disable_auto_close
boolean | null

Disable automatic incident closing.

is_external_report_enabled
boolean | null

true enables external reporting and generates a new token, returned in the response (any previous token stops working); false disables it and clears the token.

event_group
object

Alert event merge configuration; replaces the stored configuration as a whole when present.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Contains external_report_token only when the request set is_external_report_enabled to true; otherwise data is an empty object.