---
title: "Refresh Channel Health"
method: POST
path: "/admin/channels/{channel_id}/health/refresh"
tags: ["admin", "channels"]
---

# Refresh Channel Health

`POST /admin/channels/{channel_id}/health/refresh`

## 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/admin/channels/{channel_id}/health/refresh`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Path parameters

- `channel_id` string, required

## Query parameters

- `organization_id` string, required: Organization ID that owns the channel.

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `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

## Response `200`

Successful Response

- ChannelHealthPublic
  - `channel_id` string, required
  - `status` 'healthy' | 'unhealthy' | 'unknown', required
  - `checks` ChannelHealthCheckPublic[], required
    - `name` string, required
    - `status` 'pass' | 'fail' | 'unknown', required
    - `reason` string, nullable
    - `provider_error_code` string, nullable
  - `reason` string, nullable
  - `provider_error_code` string, nullable
  - `checked_at` string, date-time, required
  - `cached` boolean

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