Ask a fan to pay now
The gate’s ask for one fan, when you decide: a chatter’s “ask them to pay” button, or your own timing.
Questions? [email protected]
The gate’s ask for one fan, when you decide: a chatter’s “ask them to pay” button, or your own timing.
Questions? [email protected]
/api/external/v1/chat-gate/asksalso served at /api/external/chat-gate/asksNewThe gate’s ask for one fan, when you decide: a chatter’s “ask them to pay” button, or your own timing.
The answer has the shape of check, and on action: "ask" the steps are the same: send, pin, unpin, report.
Unlike check it doesn’t wait out the 12 hours since the last ask, a person having the chat, or the creator talking. Two requests within a minute are one ask (reason: "asked_recently"), and a fan who may already chat gets none. It works only while Pay to Chat or Sub to Chat is on for the account; for links you can send at any time, see GET /chat-gate/message.
Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.
For a creator you manage or onboarded
POST /api/external/v1/creators/{creatorId}/chat-gate/asks — 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). |
fan | string | Required | Telegram user id of the fan (the private chat’s id). |
languageCode | string | Optional | The fan’s Telegram language_code, for the ask’s language. |
accountName | string | Optional | The account’s first name for the ask; defaults to the one you reported. |
{
"account": "5550001111",
"fan": "48213377"
}| Name | Type | Description |
|---|---|---|
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 |
status | string | open the gate is off; team the creator, their agency or Dropfans staff; exempt on the Accept for list; subscribed / paid let in by money; opened an app opened the chat itself ([POST /chat-gate/fans/open](/developers/reference/open-chats)); locked would be asked.One of: open, team, exempt, subscribed, paid, opened, locked |
locked | boolean | The fan would have to pay. |
action | string | Send the ask, or nothing. One of: none, ask |
reason | string | Why. One of: asked, no_subscription_on_sale, not_locked, self, service, asked_recently, no_username |
ask | object | null | Set on action: "ask": the same object check returns. |
{
"mode": "PAY",
"payScope": "ONCE",
"source": "creator",
"status": "locked",
"locked": true,
"action": "ask",
"reason": "asked",
"ask": {
"id": "ask_9b1e4c7a2d5f8a3b6c0d1e2f",
"text": "❌ Mia has Pay to Chat turned on. Send a tip of any amount to start a conversation and they'll be notified right away 💬",
"replyMarkup": {
"inline_keyboard": [
[
{
"text": "💵 Send a tip",
"url": "https://t.me/DropfansBot/app?startapp=t_mia"
}
]
]
},
"pin": true,
"unpinMessageId": 4211,
"locale": "en"
}
}| 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":"fan must be a Telegram user id (digits, as a string)","code":"invalid_telegram_id"} | `fan` is missing or not a Telegram user id. |
| 409 | {"error":"Pay to Chat and Sub to Chat are off for this account, so there is no ask to send.","code":"gate_off"} | The setting that applies to the account is `EVERYONE`. |
| 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 POST "https://www.dropfans.io/api/external/v1/chat-gate/asks" \
-H "Authorization: Bearer $DROPFANS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"account": "5550001111",
"fan": "48213377"
}'const res = await fetch(`https://www.dropfans.io/api/external/v1/chat-gate/asks`, {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"account": "5550001111",
"fan": "48213377"
}),
});
console.log(await res.json());import os
import requests
res = requests.post(
"https://www.dropfans.io/api/external/v1/chat-gate/asks",
headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
json={
"account": "5550001111",
"fan": "48213377",
},
)
print(res.json())