Skip to content
Docs
Select language:English

/api/v1/me/notification-settings (PUT)

PUT
/api/v1/me/notification-settings
curl --request PUT \
  --url https://example.com/api/v1/me/notification-settings \
  --header 'Content-Type: application/json' \
  --data '{ "digestTime": "example", "quietFrom": "example", "quietTo": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
digestTime
string
/^([01]\d|2[0-3]):[0-5]\d$/
quietFrom
Any of:
string
/^([01]\d|2[0-3]):[0-5]\d$/
quietTo
Any of:
string
/^([01]\d|2[0-3]):[0-5]\d$/
Examplegenerated
{
  "digestTime": "example",
  "quietFrom": "example",
  "quietTo": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
timezone
required
string
digestTime
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
quietFrom
required
Any of:
string
/^([01]\d|2[0-3]):[0-5]\d$/
quietTo
required
Any of:
string
/^([01]\d|2[0-3]):[0-5]\d$/
smtpConfigured
required
boolean
push
required
object
available
required
boolean
publicKey
required
string | null
reason
string
Allowed values: no_https no_subject
apprise
required
object
available
required
boolean
channels
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: email webpush webhook ntfy telegram apprise
label
required
string | null
displayHost
required
string | null
verifiedAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
failingSince
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
subscriptions
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
label
required
string | null
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
lastSuccessAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
locations
required
Array<object>
object
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
role
required
string
Allowed values: owner admin member viewer
kinds
required
object
key
additional properties
object
inapp
required
boolean
email
required
boolean
webpush
required
boolean
webhook
required
boolean
ntfy
required
boolean
telegram
required
boolean
apprise
required
boolean
isDefault
required
boolean
set
required
Array<string>
Allowed values: inapp email webpush webhook ntfy telegram apprise
account
required
object
aiSummary
required
object
email
required
boolean
kinds
required
object
key
additional properties
object
inapp
required
boolean
email
required
boolean
webpush
required
boolean
webhook
required
boolean
ntfy
required
boolean
telegram
required
boolean
apprise
required
boolean
isDefault
required
boolean
set
required
Array<string>
Allowed values: inapp email webpush webhook ntfy telegram apprise
Example
{
  "push": {
    "reason": "no_https"
  },
  "channels": [
    {
      "kind": "email"
    }
  ],
  "locations": [
    {
      "role": "owner",
      "kinds": {
        "additionalProperty": {
          "set": [
            "inapp"
          ]
        }
      }
    }
  ],
  "account": {
    "kinds": {
      "additionalProperty": {
        "set": [
          "inapp"
        ]
      }
    }
  }
}