---
title: "Custom unsubscribe email channel"
method: GET
path: "/api/channels/email/custom-unsubscribe"
tags: ["Email"]
---

# Custom unsubscribe email channel

`GET /api/channels/email/custom-unsubscribe`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/channels/email/custom-unsubscribe`
- Auth: none declared
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/channels/email/custom-unsubscribe/get.ts> (a function with typed inputs; its response is checked against the schema)

Opts-out an email address using a custom unsubscribe token. Requires [Custom Unsubscribe](/developer/api-integrations/email/custom-unsubscribe-pages/) be enabled for your project.

This endpoint is public and does not require authentication.

## Query parameters

- `ua_unsubscribe_token` string, required
- `ua_redirect` string, uri

## Other responses

- `302`: The channel was successfully opted out and will be redirected to a confirmation page.
- `400`: There was a parsing or validation error in the request. Bad Request errors typically include `path` and `location` in the response to help you find the cause of the error.

---

[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)