Report your bot as an account’s chatbot
Tell us your bot became, changed, or stopped being the Telegram chatbot of one of the creator’s accounts; send it on every `business_connection` update.
Questions? [email protected]
Tell us your bot became, changed, or stopped being the Telegram chatbot of one of the creator’s accounts; send it on every `business_connection` update.
Questions? [email protected]
/api/external/v1/chat-gate/chatbotalso served at /api/external/chat-gate/chatbotNewTell us your bot became, changed, or stopped being the Telegram chatbot of one of the creator’s accounts; send it on every business_connection update.
The creator’s Dropfans app then shows the chat gate running through your app, and setting changes reach you as chat_gate.updated. accountName (the account’s Telegram first name) is the name the asks use.
Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.
For a creator you manage or onboarded
PUT /api/external/v1/creators/{creatorId}/chat-gate/chatbot — an agency's own key for a creator or AI persona it manages (needs canManageDrops), or your app owner's own key for an account your app onboarded. The X-Dropfans-Account header still works but is deprecated. See Acting for a creator.
Content type: application/json
| Name | Type | Required | Description |
|---|---|---|---|
account | string | Required | Telegram user id of the creator’s account (the business connection’s user.id). |
enabled | boolean | Required | The connection’s is_enabled. |
canReply | boolean | Optional | The connection’s rights.can_reply. Defaults to true while enabled. |
botUsername | string | Optional | Your bot’s username. |
accountName | string | Optional | The account’s Telegram first name (user.first_name). |
{
"account": "5550001111",
"enabled": true,
"canReply": true,
"botUsername": "your_bot",
"accountName": "Mia"
}| Name | Type | Description |
|---|---|---|
account | string | Telegram user id. |
enabled | boolean | As stored. |
canReply | boolean | As stored. |
mode | string | Who may chat: everyone, fans who paid (tip or drop) or subscribed, or subscribers only. One of: EVERYONE, PAY, SUB |
payScope | string | Pay to Chat: ONCE = paid once, open for good; PER_CONVERSATION = a conversation can be ended and the fan pays again.One of: ONCE, PER_CONVERSATION |
source | string | account: that Telegram account has its own setting; creator: the creator’s applies.One of: account, creator |
{
"account": "5550001111",
"enabled": true,
"canReply": true,
"mode": "PAY",
"payScope": "ONCE",
"source": "creator"
}| Status | Body | When |
|---|---|---|
| 400 | {"error":"account must be a Telegram user id (digits, as a string)","code":"invalid_telegram_id"} | `account` is missing or not a Telegram user id. |
| 400 | {"error":"enabled must be true or false","code":"invalid_request"} | A missing or bad field. |
| 401 | {"error":"Unauthorized","code":"unauthorized"} | Missing or invalid API key. |
| 403 | {"error":"This endpoint needs a key bound to an app with the chat_gate API category enabled — personal keys cannot use it.","code":"app_key_required","category":"chat_gate"} | A personal key: the chat gate answers back through app webhooks. |
| 409 | {"error":"The chat gate is for creator accounts.","code":"not_a_creator"} | The account is a fan account, suspended or banned. |
| 503 | {"error":"The chat gate is not available right now. Let the message through.","code":"unavailable"} | Something failed on our side. Fail open: let the message stand. |
| 400 | {"error":"X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.","code":"invalid_account_header"} | `X-Dropfans-Account` is not an account id. |
| 400 | {"error":"X-Dropfans-Account names a different account than the path — send one or the other.","code":"account_mismatch"} | Called under /v1/creators/{creatorId}/ with an `X-Dropfans-Account` naming another account. |
| 403 | {"error":"This key cannot act for that account.","code":"account_not_managed"} | The creator in the path (or `X-Dropfans-Account`) is one this key cannot act for: no ACCEPTED management by your agency and not an account your app onboarded (or it no longer holds a key bound to your app), a key minted for one creator, or someone is suspended, banned or deleted. An unknown id gets the same answer. |
| 403 | {"error":"The agency does not have permission for this on that account.","code":"permission_denied","permission":"canManageDrops"} | For a managed creator: the agency lacks `canManageDrops` on that account. |
| 403 | {"error":"This app does not have the chat_gate API category enabled. Contact support to enable it.","code":"api_category_disabled","category":"chat_gate"} | Your app has the Pay to Chat [API category](/developers/concepts/api-categories) switched off (the default for new apps). |
Every response carries the X-RateLimit-Tier header and, on limited tiers, the per-minute and per-day trios — read X-RateLimit-Remaining and X-RateLimit-Reset instead of hardcoding limits. Details in Rate limits.
curl -X PUT "https://www.dropfans.io/api/external/v1/chat-gate/chatbot" \
-H "Authorization: Bearer $DROPFANS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account": "5550001111",
"enabled": true,
"canReply": true,
"botUsername": "your_bot",
"accountName": "Mia"
}'const res = await fetch(`https://www.dropfans.io/api/external/v1/chat-gate/chatbot`, {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"account": "5550001111",
"enabled": true,
"canReply": true,
"botUsername": "your_bot",
"accountName": "Mia"
}),
});
console.log(await res.json());import os
import requests
res = requests.put(
"https://www.dropfans.io/api/external/v1/chat-gate/chatbot",
headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
json={
"account": "5550001111",
"enabled": True,
"canReply": True,
"botUsername": "your_bot",
"accountName": "Mia",
},
)
print(res.json())