UPupsmith
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)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

channel_idstring required

Query parameters

organization_idstring required

Organization ID that owns the channel.

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

channel_idstring required
status'healthy' | 'unhealthy' | 'unknown' required
reasonstring nullable
provider_error_codestring nullable
checked_atstring date-time required
cachedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.