Workspace Notification Summary
Update Workspace Notification Summary
Endpoint to update an existing Workspace Notification Summary
put/workspace-notification-summary/{id}
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Workspace Notification Summary to update
Request body
Example request
{
"data": {
"name": "This is an example of longer text content that provides detailed information.",
"workspaceType": "This is an example of longer text content that provides detailed information.",
"summaryType": "Example Text",
"recurringInterval": {
"key": "value",
"nested": {
"data": 123
}
},
"numberOfDaysOfData": 42,
"channelNames": {
"key": "value",
"nested": {
"data": 123
}
},
"summaryItems": {
"key": "value",
"nested": {
"data": 123
}
},
"isEnabled": true
}
}Response
Updated successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "This is an example of longer text content that provides detailed information.",
"description": "This is an example of longer text content that provides detailed information.",
"workspaceType": "This is an example of longer text content that provides detailed information.",
"summaryType": "Example Text",
"recurringInterval": {
"key": "value",
"nested": {
"data": 123
}
},
"numberOfDaysOfData": 42,
"sendFirstReportAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"timezone": "Example Text",
"channelNames": {
"key": "value",
"nested": {
"data": 123
}
},
"teamName": "This is an example of longer text content that provides detailed information.",
"summaryItems": {
"key": "value",
"nested": {
"data": 123
}
},
"filters": {
"key": "value",
"nested": {
"data": 123
}
},
"filterCondition": "Example Text",
"nextSendAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastSentAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"isEnabled": true,
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"deletedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.