POST v2/apps/{appId}/tenant/{tenantId}/newsalert
Creates a new 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 Create Request
NewsAlertCreateRequest| Name | Type | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
{
"type": 1,
"title": "sample string 2",
"message": "sample string 3",
"language": "sample string 4",
"actionName": "sample string 5",
"actionUrl": "sample string 6",
"imageUrl": "sample string 7",
"isActive": true
}
<NewsAlertCreateRequest 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 5</ActionName> <ActionUrl>sample string 6</ActionUrl> <ImageUrl>sample string 7</ImageUrl> <IsActive>true</IsActive> <Language>sample string 4</Language> <Message>sample string 3</Message> <Title>sample string 2</Title> <Type>1</Type> </NewsAlertCreateRequest>
Response Information
Resource Description
NewsAlertResponse| Name | 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-11-01T19:09:36.7147533Z"
}
<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-11-01T19:09:36.7147533+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>