Sign in
Notification Channels

Update a notification channel

Update an existing notification channel. Only provided fields are updated. Channels provided by chat bots cannot be updated.

put/v1/notification-channels/{channel-name}

Path parameters

channel-namestring required

Channel name

Request body

descriptionstring

Channel description

driverNamestring

Notification driver name

configurationstring

Driver-specific configuration (XML or NXSL script)

Response

Notification channel updated successfully

namestring

Channel name

descriptionstring

Channel description

driverNamestring

Notification driver name

configurationstring

Driver-specific configuration

driverInitializedboolean

Whether the driver was initialized successfully

needSubjectboolean

Whether the driver requires a subject field

needRecipientboolean

Whether the driver requires a recipient field

errorMessagestring

Last error message

sendStatusinteger

Last send status code

healthCheckStatusboolean

Health check status

lastMessageTimestring

Timestamp of last sent message

messageCountinteger

Total messages sent

failureCountinteger

Total send failures

digestedCountinteger

Total messages absorbed into digest

queueSizeinteger

Current message queue size

providedByChatBotboolean

Whether the channel is provided by a chat bot (such channels cannot be modified, renamed, or deleted)

Changes

Changed in 1 of the 75 revisions of this API.2

  • 2432d610460c2See the full diff
    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the optional property providedByChatBot to the response with the 200 status

      response-optional-property-added