Notification Deletion API


Permanently delete a pending notification.

  • API Reference
  • Test it out
  • DELETE https://api.pushy.me/pushes/PUSH_ID?api_key=SECRET_API_KEY

    Note: Make sure to replace SECRET_API_KEY with your app's Secret API Key, available in the Dashboard. This is a backend API endpoint. Never expose your application's Secret API Key in your client code.

    URL Parameters

    Field Description Example
    PUSH_ID
    String
    The push notification ID, provided in the Send Notifications API response JSON. 5ea9b214b47cad768a35f13a
    API Response

    Sample Response Body

    {
        "success": true
    }
    Response Schema

    Field Description Example
    success
    Boolean
    Returned if the API request was successful. true
    API Error Reference

    Sample Error Response

    {
        "code": "INVALID_PUSH_ID", 
        "error": "The push notification ID provided is invalid."
    }
    Error Codes

    A list of endpoint-specific error codes, in addition to the global API errors.

    Error code Description HTTP status code
    INVALID_PUSH_ID

    The PUSH_ID provided is invalid or no longer exists, or the push was not sent from the app whose SECRET_API_KEY you are using to authenticate.

    Push notifications are automatically deleted by our system 2 days after they are delivered to all recipients, or once they expire.

    400 Bad Request
  • DELETE https://api.pushy.me/pushes/PUSH_ID?api_key=SECRET_API_KEY
    URL Param Value
    PUSH_ID
    SECRET_API_KEY
    API Response

    500 CLIENT ERROR

    N/A