Uninstall email channel

Removes an email address from Airship. Use with caution. If the uninstalled email address opts-in again, it might generate a new channel_id. If a user generates a new channel_id when they opt-in again, the new channel_id cannot be reassociated with any opt-in information, tags, named users, Performance Analytics reports, or other information from the that belonged to the previously-uninstalled email channel.

post/api/channels/email/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/email/uninstall/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

email_addressstring required

The email address of the channel to uninstall.

Example request

{
  "email_address": "name@example.com"
}

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.