Sign in
Notification Preferences

Upsert workspace rule

Create or replace the notification rule for one workspace, overriding the global settings there.

put/notification-preferences/workspaces/{workspaceId}

Path parameters

workspaceIdstring required

Request body

isActiveboolean required
emailEnabledboolean required
ntfyEnabledboolean required
gotifyEnabledboolean required
webhookEnabledboolean required
projectMode'all' | 'selected' required
selectedProjectIdsstring[]

Required in practice when projectMode is selected.

Response

The updated preferences

emailAddressstring nullable required
emailEnabledboolean required
ntfyEnabledboolean required
ntfyConfiguredboolean required
ntfyServerUrlstring nullable required
ntfyTopicstring nullable required
ntfyTokenConfiguredboolean required
maskedNtfyTokenstring nullable required
gotifyEnabledboolean required
gotifyConfiguredboolean required
gotifyServerUrlstring nullable required
gotifyTokenConfiguredboolean required
maskedGotifyTokenstring nullable required
webhookEnabledboolean required
webhookConfiguredboolean required
webhookUrlstring nullable required
webhookSecretConfiguredboolean required
maskedWebhookSecretstring nullable required
taskAssignmentEnabledboolean required
taskCommentEnabledboolean required
taskStatusChangeEnabledboolean required
dueDateReminderEnabledboolean required
dueDateReminderLeadTimeMinutesnumber required

How long before a due date the reminder fires, in minutes.

createdAtstring date-time nullable required
updatedAtstring date-time nullable required

Changes

Changed in 2 of the 23 revisions of this API.58

  • 08bbb5bedb5d57See the full diff
    • ▲

      removed the media type application/json for the response with the status 400

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 401

      response-media-type-removed

    • ▲

      removed the media type application/json for the response with the status 403

      response-media-type-removed

    • ▲

      the createdAt response's property type/format changed from / to string null/date-time for status 200

      response-property-type-changed

    • ▲

      the updatedAt response's property type/format changed from / to string null/date-time for status 200

      response-property-type-changed

    • ○

      added the media type text/plain for the response with the status 400

      response-media-type-added

    • ○

      added the media type text/plain for the response with the status 403

      response-media-type-added

    • ○

      added the required property dueDateReminderEnabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property dueDateReminderLeadTimeMinutes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property taskAssignmentEnabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property taskCommentEnabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property taskStatusChangeEnabled to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 32cece1ebe431See the full diff
    • ○

      endpoint added

      endpoint-added