ALallquiet
OutboundIntegrationResource

Update an outbound integration

Updates an existing outbound integration by ID, including forwarding behavior and channel settings.

Required API key permissions

  • Scope: outbound-integrations:update
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Access is checked against the specific resource (team or organization reachability).
  • Required team role (user-linked keys only): Administrator
  • Organization API keys are not subject to organization or team role checks.
put/api/public/v1/outbound-integration/{id}

Request

Path parameters

idstring uuid required

Query parameters

provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

teamIdstring uuid nullable
displayNamestring required
triggersOnlyOnForwardedboolean nullable
skipUpdatingAfterForwardingboolean nullable
anonymizeOutboundLogsboolean nullable

Response

OK

idstring uuid
isProvisionedboolean
displayNamestring nullable
typestring nullable
teamIdstring uuid
triggersOnlyOnForwardedboolean nullable
skipUpdatingAfterForwardingboolean nullable
anonymizeOutboundLogsboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.