Skip to main content
PUT
Update a channel

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Yol Parametreleri

id
integer
gerekli

The channel identifier

Gövde

application/json
name
string

The display name of the channel, stored upper-cased and unique per tenant. Renaming a WhatsApp channel does not touch its provider instance.

Maximum string length: 255
provider
string | null

The messaging provider backing the channel.

Maximum string length: 255
address
string

The channel address — a phone number, handle or bot identifier.

Maximum string length: 255
website_domain
string

The site the widget is embedded on, without a scheme. Website channels only.

Maximum string length: 255
Pattern: ^(?:localhost|(?:\d{1,3}\.){3}\d{1,3}|(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+))(?:\:\d{1,5})?$
is_active
boolean

Whether the channel is active.

ai_reply_mode
enum<string> | null

Pins the channel to a fixed AI reply mode (auto, semi_auto, closed). Send null to follow the clinic schedule again.

Mevcut seçenekler:
auto,
semi_auto,
closed
bot_token
string

Telegram channels only. A new BotFather token; the bot is verified and the webhook re-registered before anything is saved. Omit to keep the stored token. Write-only: it is never returned.

Maximum string length: 255
Pattern: ^\d+:[A-Za-z0-9_-]+$
webhook_enabled
boolean

Telegram channels only. Turns webhook delivery of incoming messages on or off; the change is applied on Telegram with the stored token.

webhook_base_url
string<uri> | null

Telegram channels only, non-production only. The public HTTPS base URL the webhook is registered under. Ignored in production.

Maximum string length: 255

Yanıt

success
string
gerekli
data
ChannelResource · object
gerekli