/
alert_delete ()

alert_delete ()

Owned by Pedro Jose Sanchez Luling
Mar 16, 2022
1 min read

Function prototype

alert_delete (session, ref)

API Version

2.7.24 and higher

Deletes an alert

This function deletes an alert of the active user.

This operation is only permitted if the alert is addressed to the active user.

Input parameters:

  • session: is the session token obtained in the session_init() call

  • ref: A valid notification reference (can be obtained with alert_list () )

Output parameters:

  • result: empty

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request sample:

alert_delete( “LCAAAAAAAAAAAA”, 25642);

Response sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?> <result></result> <ErrorMsg></ErrorMsg> <ErrorCode></ErrorCode>





Return Error codes

ERROR CODE



ERROR CODE



INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The alert does not belong to the active user



Related content