ONonesignal

Delete user

Delete a user including all associated properties, subscriptions, and identity.

delete/apps/{app_id}/users/by/{alias_label}/{alias_id}

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/users/by/{alias_label}/{alias_id}
  • Auth
    none required

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

alias_labelstring required

The alias name or key to locate the user. Most commonly set as external_id but can be the onesignal_id or a custom alias.

alias_idstring required

The specific identifier for the given alias to identify the user.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Response

202

Example response

{
  "identity": {
    "onesignal_id": "567491ee-9105-4a87-9cbc-ed78a571645b"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.