How to submit a user keyword alert

You can submit a keyword alert for a user by using the following URL and specifying the required parameters.

 

 Method URL
 POST  https://api.fairwarningsoftware.com/v1.1.1/user/alerts/add

 

Request
{
        "user_id": <user_id>,
        "alert_keyword": <alert_keyword>
}

 

 Field  Type Description
user_id int The ID of the user requesting the alert.
alert_keyword string The keyword(s) for the alert.

 

If successful, a success response will be returned.  If not, an error will be returned instead.

 Status Response
 200 {
        "success": <success>
}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type Description
success bool Whether or not the request was successful