---
title: "Toggle Recipient Channel"
method: POST
path: "/notifications/recipients/channel"
tags: ["notifications"]
---

# Toggle Recipient Channel

`POST /notifications/recipients/channel`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/notifications/recipients/channel`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Flip one recipient channel.

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- ChannelToggleBody
  - `recipient_id` string, required
  - `channel` 'email' | 'sms' | 'app' | 'push' | 'call', required
  - `enabled` boolean, required

## Response `200`

Successful Response

- ApiSchemasNotificationNotificationsStatusResponse
  - `status` string, required

## Other responses

- `422`: Validation Error

---

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