Uninstall channels

Uninstalls a channel, removing it and all accompanying analytic data (including Performance Analytics) from Airship systems in accordance with data privacy law compliance.

Uninstallation is handled automatically by the Airship SDK and push systems. If a user decides to opt in to communications again (either by using your app or other user preferences), they will create a new channel and a new set of analytic data. The value of a channel ID may be the same as before however none of the associated metadata will persist when a user opts in again. A new channel ID will be created if the user clears their browser’s cookies and data, deletes and reinstalls the app, etc.

See Individual Data Privacy Rights Under Data Privacy Laws for more information about data privacy law compliance.

post/api/channels/uninstall

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopeschn
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/channels/uninstall/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

channel_idstring required

The channel ID.

device_type'ios' | 'android' | 'amazon' | 'web' | 'open' required

The device type of the channel.

Example request

[
  {
    "channel_id": "bd36e8c7-5a73-47c0-9716-99fd3d4197d5"
  }
]

Response

Returns OK for success.

okboolean required

Success.

operation_idstring uuid

A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple push_id strings, but a single operation_id) or operations that change an existing resource.

Changes

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