Skip to main content
POST
Update public integration

Restrictions

Usage

  • Only the fields you send are changed; omitted fields keep their current value.
  • Submitting settings replaces the configuration; known sensitive fields omitted or sent as ****** retain their value. Keeping a stored secret while changing where it is sent (such as endpoint, url, a database host or port, or an IM API base URL) is rejected, so send the secrets again with the new destination; ****** on a field with no stored value is rejected too. Send headers: {} to clear headers; use the integration type’s explicit empty value to clear a body.
  • Submit settings together with is_test: true to receive a plugin test result; secrets in the returned settings are masked the same way.
  • If another request changes the same integration’s settings while this one is being processed, the call returns RequestLocked; retry it. A type no longer included in the account’s plan returns NoLicense.
  • These APIs manage public (account-level) integrations only, not channel-owned dedicated integrations.
  • Write access also requires object permission: the account owner, an administrator, the creator, or a member of the assigned team; with no team, members with Integrations Manage may operate. Read-only integrations cannot be changed.
  • 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

Payload for updating an integration. Only the fields you send are changed.

integration_id
integer<int64>
required

ID of a public integration, returned by POST /integration/list. An unknown ID or a channel-owned integration returns ResourceNotFound.

Required range: x >= 1
Example:

6113996590131

name
string | null

New name, 2–49 characters.

Required string length: 2 - 49
description
string | null

New description, at most 499 characters.

Maximum string length: 499
team_id
integer<int64> | null

New owning team ID; 0 clears the team assignment.

Required range: x >= 0
settings
object

Replacement type-specific configuration. Known sensitive fields omitted or sent as ****** keep their stored value; an explicit empty headers object clears headers. A stored secret cannot be kept while its destination (such as endpoint, url, or a database host or port) changes.

is_test
boolean

Run the plugin test when submitting settings; no test is performed for a metadata-only update.

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

Public integration detail with stored settings and its decrypted key. Timestamps are Unix epoch seconds.