PUT api/Alerts/{affiliateId}/Cancel/{alertId}
Cancels the specified alert.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
affiliateId |
The affiliate identifier. |
integer |
Required |
alertId |
The alert identifier. |
integer |
Required |
v |
The requested API version |
string |
Default value is 2.0 |
Body Parameters
None.
Response Information
Resource Description
Cancels the specified alert.
FilmFlex.Platform.Common.API.Contracts.V2.AlertDTOName | Description | Type | Additional information |
---|---|---|---|
Id |
Gets or sets the identifier. |
integer |
None. |
AlertType |
Gets or sets the type of the alert. |
FilmFlex.Platform.Common.API.Contracts.V2.AlertType |
None. |
UserId |
Gets or sets the user identifier. |
globally unique identifier |
None. |
ReferenceId |
Gets or sets the reference identifier. |
string |
None. |
DisplayedCount |
Gets or sets the displayed count. |
integer |
None. |
ExpiryDate |
Gets or sets the expiry date. |
date |
None. |
Status |
Gets or sets the status. |
FilmFlex.Platform.Common.API.Contracts.V2.AlertStatus |
None. |
Heading |
Gets or sets the heading. |
string |
None. |
Body |
Gets or sets the body. |
string |
None. |
Url |
Gets or sets the URL. |
string |
None. |
SupplierReference |
Gets or sets the supplier reference. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "AlertType": 1, "UserId": "4aedb035-1812-4238-8a3a-203c1f7a423c", "ReferenceId": "sample string 3", "DisplayedCount": 4, "ExpiryDate": "2025-09-04T07:14:45.9771584+00:00", "Status": 1, "Heading": "sample string 6", "Body": "sample string 7", "Url": "sample string 8", "SupplierReference": "sample string 9" }