POST
/v1/notification/publisherUpdate a notification publisher
Updates an existing notification publisher, including its extension, name, description, and notification template. Supply extensionName, name, and uuid; the authenticated user needs SYSTEM_CONFIGURATION or SYSTEM_CONFIGURATION_UPDATE permission. A 200 response returns the updated notification publisher.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Notification publisher properties to update. Supply extensionName, name, and uuid.
descriptionstringoptional
A description of the notification publisher.
extensionNamestringrequired
The name of the publisher extension that handles delivery. Must contain at least one character.
namestringrequired
The notification publisher's name. Must contain at least one character.
templatestringoptional
The template used to render the notification payload.
templateMimeTypestringoptional
The MIME type of the rendered template.
uuidstringrequired
The notification publisher's UUID.
200Returns the updated notification publisher, including its default status, extension name, publisher name, template details, and UUID.
defaultPublisherbooleanrequired
Whether the publisher is one of the built-in defaults
descriptionstringoptional
Description of the notification publisher
extensionNamestringrequired
Name of the publisher extension that handles delivery
namestringrequired
Name of the notification publisher
templatestringoptional
Template used to render the notification payload
templateMimeTypestringrequired
MIME type of the rendered template
uuidstringrequired
UUID of the notification publisher
400Returned when the notification class is invalid or the request attempts to modify a default publisher.
401Returned when the request is unauthorized.
404Returned when the notification publisher cannot be found.
409Returned when the publisher name conflicts with an existing publisher.
Error handling
A 400 is returned for an invalid notification class or an attempt to modify a default publisher. A 401 is returned when the request is unauthorized, a 404 when the notification publisher cannot be found, and a 409 when its name conflicts with an existing publisher. extensionName and name must not be empty, and uuid must use UUID format.