---
title: "Uninstall SMS channel"
method: POST
path: "/api/channels/sms/uninstall"
tags: ["SMS"]
---

# Uninstall SMS channel

`POST /api/channels/sms/uninstall`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/channels/sms/uninstall`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `http://oauth2.{domain}.com/token` scopes: `chn`
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/channels/sms/uninstall/post.ts> (a function with typed inputs; its response is checked against the schema)

**Removes phone numbers and accompanying data from Airship. Use with caution.** Uninstalling an SMS channel will prevent you from retrieving opt-in and opt-out history for the corresponding msisdn. If the uninstalled msisdn opts-in again, it will generate a new channel_id. The new channel_id cannot be reassociated with any opt-in information, tags, named users, Performance Analytics reports, or other information from the uninstalled SMS channel.

## Request body

- object
  - `msisdn` string, required: The mobile phone number you want to remove from the Airship system. Must be numeric characters only, without leading zeros. 15 digits maximum.
  - `sender` string, required: A long or short code the app is configured to send from. For example, `12345`.

## Response `202`

The SMS channel and all information associated with the msisdn is uninstalled.

- object
  - `ok` boolean: If true, the operation was successful.

## Other responses

- `400`: The request body is not valid.

## Changes

- **2022-03-24** `ca569bd1394d`: 1 breaking, 1 info
  - added the new required request property `sender/sms_sender`
  - the `sender` request property's minLength was decreased from `1` to `0`

[Operation history](https://skmtc.dev/airship/apis/airship-api/changes/api/channels/sms/uninstall/post.md)

---

[API](https://skmtc.dev/airship/apis/airship-api.md) - [All operations](https://skmtc.dev/airship/apis/airship-api/llms.txt) - [OpenAPI document](https://skmtc.dev/airship/apis/airship-api/revisions/bd6ab947117a?raw)