Cancel

Cancel Notification

PUT /notification/cancel

The cancel Notification endpoint allows updating the status of a notification to ‘cancelled’. Canceling by Track Entitiy ID, we will cancel all the clientId events. Canceling by event ID, we will cancel a single event.

This cancel-notification endpoint allows for the cancellation of notifications either by the Track Entity ID or by the Event ID, providing flexibility in managing and removing notifications from the system. Adjust the specifications or examples as needed to align with your service implementation.

The following statuses are assigned to the notifications accordingly:

Cancelled
Sent
Scheduled
Error
Unsent

Upon successful cancellation, a confirmation response will be returned. If the operation encounters an issue or the notification cannot be canceled, appropriate error messages will be provided.

The status update will be applied only if the notification has not being sent.

Request Body

{ 
  "project": "",
  "templateId": "",
  "notificationID": "",
  "clientId": "",
}

Parameter Name	Type	Required	Description

Parameter Name	Type	Required	Description
project	string	Yes	Reference project to send notifications. This allows the app to store data in a different data persistence tool. Supported values: LAC-FP
templateId	string	Optional	Identifier used by the specified channel to use a pre-defined template.
notificationID	string	Optional	Id assigned to a notification.
clientId	string	Optional	Id assigned to a client.

Request body to cancel by client ID

{ 
  "project": "LAC-FP",
  "clientId": "019283SFD"
}

Request body to cancel by Notification ID

{ 
  "project": "LAC-FP",
  "notificationId": "A019283FD"
}

Request body to cancel by client ID & Multiple TemplateId

Request body to cancel by client ID & Single TemplateId

Responses

200: Success

404: Not Found. Request was procesed but entity was not found.

422: Unprocessable Entity. Missing required properties in Request Body.

Parameter(s) missing

Project ID - Always
OR Client ID
OR Client ID + TemplateId(s)
OR NotificationId

Platform 2.0