PUT v2/apps/{appId}/tenant/{tenantId}/newsalert
Update existing news alert to be displayed on the Tenant Side
Request Information
URI Parameters
Name | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
appId | integer |
Application Id
Additional Info :
Required |
|||||||||||
tenantId | integer |
Tenant Id
Additional Info :
Required |
Body Parameters
News Alert Update Request
NewsAlertUpdateRequestName | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Id | integer |
Id
Additional Info :
Required |
|||||||||||
Type | integer |
Type [1 for info, 2 for warning, 3 for danger] |
|||||||||||
Title | string |
Title
Additional Info :
Max length: 50 |
|||||||||||
Message | string |
Title
Additional Info :
Required Max length: 250 |
|||||||||||
Language | string |
Language [en, es]
Additional Info :
Required |
|||||||||||
ActionName | string |
Action Button name
Additional Info :
Max length: 25 |
|||||||||||
ActionUrl | string |
Url that will be use when the user clicks the action button |
|||||||||||
ImageUrl | string |
Image you want to display in the alert. please make sure that the url is public. |
|||||||||||
IsActive | boolean |
Set the newly created new alert to active making the prevous active alert to inactive |
Request Formats
{ "id": 1, "type": 2, "title": "sample string 3", "message": "sample string 4", "language": "sample string 5", "actionName": "sample string 6", "actionUrl": "sample string 7", "imageUrl": "sample string 8", "isActive": true }
<NewsAlertUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models.Request"> <ActionName>sample string 6</ActionName> <ActionUrl>sample string 7</ActionUrl> <Id>1</Id> <ImageUrl>sample string 8</ImageUrl> <IsActive>true</IsActive> <Language>sample string 5</Language> <Message>sample string 4</Message> <Title>sample string 3</Title> <Type>2</Type> </NewsAlertUpdateRequest>
Response Information
Resource Description
NewsAlertResponseName | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Id | integer |
Id |
|||||||||||
Type | integer |
Type [1 for info, 2 for warning, 3 for danger] |
|||||||||||
Title | string |
Title
Additional Info :
Max length: 50 |
|||||||||||
Message | string |
Message
Additional Info :
Required Max length: 250 |
|||||||||||
Language | string |
Language [en, es]
Additional Info :
Required |
|||||||||||
ActionName | string |
Action Button name
Additional Info :
Max length: 25 |
|||||||||||
ActionUrl | string |
Url that will be use when the user clicks the action button |
|||||||||||
ImageUrl | string |
Image you want to display in the alert. please make sure that the url is public. |
|||||||||||
IsActive | boolean |
Set the newly created new alert to active making the prevous active alert to inactive |
|||||||||||
CreateDate | date |
Response Formats
{ "id": 1, "type": 2, "title": "sample string 3", "message": "sample string 4", "language": "sample string 5", "actionName": "sample string 6", "actionUrl": "sample string 7", "imageUrl": "sample string 8", "isActive": true, "createDate": "2024-09-07T23:43:22.6888507Z" }
<NewsAlertResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models.Response"> <ActionName>sample string 6</ActionName> <ActionUrl>sample string 7</ActionUrl> <CreateDate>2024-09-07T23:43:22.6888507+00:00</CreateDate> <Id>1</Id> <ImageUrl>sample string 8</ImageUrl> <IsActive>true</IsActive> <Language>sample string 5</Language> <Message>sample string 4</Message> <Title>sample string 3</Title> <Type>2</Type> </NewsAlertResponse>