Operations with Specific NotificationSettings
This resource lets you work with the notification settings of your YouTrack service: read and configure Email server settings to enable notifications to users.
Resource | |
|---|---|
Returned entity | NotificationSettings. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents the Notifications settings of the YouTrack service.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the NotificationSettings entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the NotificationSettings. |
emailSettings | Settings for sending emails. |
Read the Notification settings of your YouTrack service.
Requires permissions: Low-level Admin Read
GET /api/admin/globalSettings/notificationSettings?{fields}null | Database ID of NotificationSettings |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of NotificationSettings attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/globalSettings/notificationSettings?fields=emailSettings(isEnabled,host,port,mailProtocol,anonymous,login,from,replyTo){
"emailSettings": {
"login": null,
"from": "service@youtrack.cloud",
"mailProtocol": "SMTP_TLS",
"replyTo": null,
"anonymous": false,
"port": 587,
"isEnabled": true,
"host": "10.20.1.6",
"$type": "EmailSettings"
},
"$type": "NotificationSettings"
}Change the Notification settings of your YouTrack service.
Requires permissions: Low-level Admin Write
POST /api/admin/globalSettings/notificationSettings?{fields}null | Database ID of NotificationSettings |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of NotificationSettings attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/globalSettings/notificationSettings?fields=emailSettings(isEnabled,from,replyTo){
"emailSettings": {
"from": "youtrack@mycompany.com"
}
}{
"emailSettings": {
"isEnabled": true,
"from": "youtrack@mycompany.com",
"replyTo": null,
"$type": "EmailSettings"
},
"$type": "NotificationSettings"
}