social.colibri.beta.notification.unregisterPush Documentation (EN)

main procedure

Removes a previously registered push endpoint.

Input

Encodingapplication/json

endpoint stringuri Optional

The Web Push subscription endpoint to remove.

provider string Required

The push provider to unregister from.

token string Optional

The FCM registration token to remove.

Output

Encodingapplication/json

Errors

AuthRequired The request has no valid service auth.

InvalidRequest The arguments are inconsistent or malformed beyond schema validation.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "provider"
      ],
      "properties": {
        "token": {
          "type": "string",
          "description": "The FCM registration token to remove."
        },
        "endpoint": {
          "type": "string",
          "format": "uri",
          "description": "The Web Push subscription endpoint to remove."
        },
        "provider": {
          "type": "string",
          "description": "The push provider to unregister from.",
          "knownValues": [
            "webpush",
            "fcm"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "InvalidRequest",
      "description": "The arguments are inconsistent or malformed beyond schema validation."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "properties": {}
    },
    "encoding": "application/json"
  },
  "description": "Removes a previously registered push endpoint."
}