NetBird Full API Reference + Read-Only MCP Prototype
PUT/api/integrations/notifications/channels/{channelId}

Replace a notification channel configuration

Replaces the configuration of an existing notification channel. Supply type, event_types, and enabled; choose email or webhook and provide the matching target configuration. Use GET /api/integrations/notifications/types to find supported event type codes.

1 parameter · 4 body fields
channelIdstringrequired
The unique identifier of the notification channel to update.

Notification channel configuration. type, event_types, and enabled are required.

enabledbooleanrequired
Whether this notification channel is active.
event_typesarray<string>required
List of activity event type codes this channel subscribes to.
targetobjectoptional
Channel-specific target configuration. The shape depends on the `type` field: - `email`: requires an `EmailTarget` object - `webhook`: requires a `WebhookTarget` object
typestringrequired
The type of notification channel.
Allowed:emailwebhook

6 status codes
200Returns the updated notification channel configuration, including its identifier, type, event types, and enabled state.
enabledbooleanrequired
Whether this notification channel is active.
event_typesarray<string>required
List of activity event type codes this channel subscribes to.
idstringrequired
Unique identifier of the notification channel.
targetobjectoptional
Channel-specific target configuration. The shape depends on the `type` field: - `email`: an `EmailTarget` object - `webhook`: a `WebhookTarget` object
typestringrequired
The type of notification channel.
Allowed:emailwebhook
400Returned when the request is invalid, including when required fields are missing or `type` is not an accepted value.
401Returned when authentication is required.
403Returned when access to the requested resource is forbidden.
404Returned when the notification channel is not found.
500Returned when an internal server error occurs.

Error handling

A 400 indicates a bad request, a 401 indicates authentication is required, and a 403 indicates access is forbidden. A 404 means the notification channel was not found, and a 500 indicates an internal server error. The channelId path parameter must identify an existing notification channel. The body must include type, event_types, and enabled; type must be email or webhook.