Skip to main content
POST
Update dedicated integration

Restrictions

Usage

  • These APIs manage channel-owned dedicated integrations; use /integration/* for public integrations.
  • The App Key’s api_scopes must allow the operation; permissions follow the user who owns the key.
  • You also need management access to the target channel: the account owner, an Admin, the channel creator, or a managing-team member. The owning team applies when no managing team is set.
  • Creating the integration does not independently grant channel management access; Integrations Manage does not grant access to this endpoint.
  • The complete integration_key is returned; saved secret values in settings are returned as ******. The integration key authenticates alert ingestion and is separate from the management App Key.
  • Only supplied fields change; omitted or null fields retain their value. Send description: "" to clear the description.
  • Supplied settings follow the integration type configuration rules; masked or omitted secret fields retain their stored value. Retaining a secret does not allow changing its corresponding destination.
  • This endpoint does not change the channel, integration type, or integration key.
  • Every call is recorded in the account audit log.
  • Concurrent changes to integrations in the same channel return RequestLocked; retry after the current change completes.

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

Partial update of a dedicated integration; omitted or null fields keep their value.

integration_id
integer<int64>
required

Dedicated integration ID returned by create, list, or info. Public integration IDs are not accepted.

Required range: x >= 1
Example:

10001

name
string | null

New name, 2–49 characters; omitted or null keeps the stored name.

Required string length: 2 - 49
description
string | null

New description, at most 499 characters; empty clears it, omitted or null keeps it.

Maximum string length: 499
settings
object | null

Replacement type-specific configuration. Omitted or null keeps it; masked or omitted secret fields retain their stored value.

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

A channel-owned dedicated integration, with its complete key and masked settings.