---
title: "Put Notification Channel entity"
method: PUT
path: "/api/v1/entities/notificationChannels/{id}"
tags: ["Notification Channels"]
---

# Put Notification Channel entity

`PUT /api/v1/entities/notificationChannels/{id}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/notificationChannels/{id}`
- Auth: none declared

## Path parameters

- `id` string, required

## Query parameters

- `filter` string

## Request body

- JsonApiNotificationChannelInDocument
  - `data` JsonApiNotificationChannelIn, required: JSON:API representation of notificationChannel entity.
    - `attributes` object
      - `allowedRecipients` 'CREATOR' | 'INTERNAL' | 'EXTERNAL': Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
      - `customDashboardUrl` string: Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
      - `dashboardLinkVisibility` 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL': Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
      - `description` string, nullable
      - `destination` union: The destination where the notifications are to be sent.
        - DefaultSmtp: Default SMTP destination for notifications.
          - `fromEmail` string, email: E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.
          - `fromEmailName` string: An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.
          - `type` 'DEFAULT_SMTP', required: The destination type.
        - InPlatform: In-platform destination for notifications.
          - `type` 'IN_PLATFORM', required: The destination type.
        - Smtp: Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
          - `fromEmail` string, email: E-mail address to send notifications from.
          - `fromEmailName` string: An optional e-mail name to send notifications from.
          - `host` string: The SMTP server address.
          - `password` string: The SMTP server password.
          - `port` 25 | 465 | 587 | 2525: The SMTP server port.
          - `type` 'SMTP', required: The destination type.
          - `username` string: The SMTP server username.
        - Webhook: Webhook destination for notifications. The property url is required on create and update.
          - `hasSecretKey` boolean, nullable: Flag indicating if webhook has a hmac secret key.
          - `hasToken` boolean, nullable: Flag indicating if webhook has a token.
          - `secretKey` string, nullable: Hmac secret key for the webhook signature.
          - `token` string, nullable: Bearer token for the webhook.
          - `type` 'WEBHOOK', required: The destination type.
          - `url` string: The webhook URL.
      - `inPlatformNotification` 'DISABLED' | 'ENABLED': In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
      - `name` string, nullable
      - `notificationSource` string: Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
    - `id` string, required: API identifier of an object
    - `type` 'notificationChannel', required: Object type

## Response `200`

Request successfully processed

- JsonApiNotificationChannelOutDocument
  - `data` JsonApiNotificationChannelOut, required: JSON:API representation of notificationChannel entity.
    - `attributes` object
      - `allowedRecipients` 'CREATOR' | 'INTERNAL' | 'EXTERNAL': Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
      - `customDashboardUrl` string: Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
      - `dashboardLinkVisibility` 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL': Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
      - `description` string, nullable
      - `destination` union: The destination where the notifications are to be sent.
        - DefaultSmtp: Default SMTP destination for notifications.
          - `fromEmail` string, email: E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.
          - `fromEmailName` string: An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.
          - `type` 'DEFAULT_SMTP', required: The destination type.
        - InPlatform: In-platform destination for notifications.
          - `type` 'IN_PLATFORM', required: The destination type.
        - Smtp: Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update
          - `fromEmail` string, email: E-mail address to send notifications from.
          - `fromEmailName` string: An optional e-mail name to send notifications from.
          - `host` string: The SMTP server address.
          - `password` string: The SMTP server password.
          - `port` 25 | 465 | 587 | 2525: The SMTP server port.
          - `type` 'SMTP', required: The destination type.
          - `username` string: The SMTP server username.
        - Webhook: Webhook destination for notifications. The property url is required on create and update.
          - `hasSecretKey` boolean, nullable: Flag indicating if webhook has a hmac secret key.
          - `hasToken` boolean, nullable: Flag indicating if webhook has a token.
          - `secretKey` string, nullable: Hmac secret key for the webhook signature.
          - `token` string, nullable: Bearer token for the webhook.
          - `type` 'WEBHOOK', required: The destination type.
          - `url` string: The webhook URL.
      - `destinationType` 'WEBHOOK' | 'SMTP' | 'DEFAULT_SMTP' | 'IN_PLATFORM', nullable
      - `inPlatformNotification` 'DISABLED' | 'ENABLED': In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
      - `name` string, nullable
      - `notificationSource` string: Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
    - `id` string, required: API identifier of an object
    - `type` 'notificationChannel', required: Object type
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)