Remove a specific alias from a user.

How to Use this API

To specify the user whose alias needs to be removed, provide a known alias and then indicate the alias label you want to delete. The alias label to delete can match the alias used to identify the user. This action is performed synchronously, ensuring that the alias is deleted immediately.

Please note that the OneSignal ID alias can't be deleted; only other aliases can be removed.


Path Parameters

alias_label

Description

The name of the alias to use to fetch a user. All users include a special OneSignal ID alias named onesignal_id.

Guidance

  • We recommend fetching users via your identifier using the External ID alias: external_id.
  • Refer to our guide on Aliases & External ID for further details.

alias_id

Description

The specific identifier for a given Alias to identify the user.

Guidance

alias_label_to_delete

Description

The alias to remove.

Guidance

  • You cannot move External ID and OneSignal ID aliases.

Language