DropfansDropfans
Help CenterFAQDevelopersMini AppSign upLog in
Check a private message
Get started
Dropfans APIMake your first callConnect a creator to your appTesting without a sandboxApply for API access
Concepts
Authentication & API keysApps & approvalAPI categoriesRate limitsErrorsPagination & batch limitsModeration & statusesMoney & unitsActing for a creator: agencies and CRMs
Guides
Sell a drop end-to-endUpload images, audio and videoLinks & Telegram deep linksPost to the For You feedEarnings & balanceBroadcast one drop to many fansCreator sign-up from your platformPay to Chat from your own chatbotBuild your own CRM dashboard
Webhooks
Webhooks & polling
Build with AI
Build with AIAgent prompt
API v1 (OAuth apps)
OAuth appsAPI v1 overviewAPI v1 resource listAPI v1 webhooks
API reference
API reference overview
▶Account
GETGet the account for this API keyGETGet the profile for a creatorNewPATCHUpdate the profile for a creatorNewGETGet the timezone for a creatorPUTUpdate the timezone for a creatorGETGet the subscription tier for a creatorNewPUTUpdate the subscription tier for a creatorNewGETGet the payout balance for a creator
▶Agencies
GETGet creators and personas for your agencyNewPOSTCreate an AI persona for your agencyNewPATCHUpdate an AI persona for your agencyNewDELDelete an AI persona for your agency (retire)NewPOSTReactivate an AI persona for your agencyNewPOSTCreate a creator invite for your agencyNewGETGet invites for your agency (cursor-paginated)NewDELDelete an invite for your agency (revoke)NewDELRemove a creator from your agencyNewGETGet revenue stats for your agencyNewGETGet daily earnings per creator for your agency (cursor-paginated)New
▶Creators you act for
GETGet creators you can act for (cursor-paginated)NewGETGet a creator you can act forNew
▶Vault
GETGet vault items for a creator (page-paginated)POSTUpload a vault item for a creatorDELDelete a vault item for a creatorPATCHUpdate a vault item’s folder for a creatorPATCHUpdate a vault item’s tags for a creatorGETGet vault folders for a creatorPOSTCreate a vault folder for a creatorDELDelete a vault folder for a creatorPOSTStart a video upload for a creator (step 1 of 3)POSTComplete a video upload for a creator (step 3 of 3)POSTCheck video status for a creator (batch)POSTCreate a media upload for a creatorNewPUTUpload a media upload part for a creatorNewPOSTComplete a media upload for a creatorNewGETGet a media upload for a creatorNew
▶Drops
POSTCreate a drop for a creatorGETGet drops for a creator (cursor-paginated)NewGETGet a drop for a creatorNewPATCHUpdate a drop for a creatorNewDELDelete (archive) a drop for a creatorNewPOSTAttach blur previews to a drop for a creatorPOSTCheck drop sales for a creator (batch)GETGet paid orders for a creator (cursor-paginated)New
▶Posts
POSTCreate a post for a creatorGETGet posts for a creator (page-paginated)GETGet a post for a creatorDELDelete a post for a creator
▶Earnings
GETGet the earnings overview for a creatorGETGet the earnings summary for a creatorNewGETGet transactions for a creator (cursor-paginated)NewGETGet paid tips for a creator (cursor-paginated)New
▶Links
GETGet links for a creatorNewPOSTCreate a link for a creatorNew
▶Telegram (advanced)
GETGet Telegram notification settings for a creatorPUTUpdate Telegram notification settings for a creatorPOSTRegister a Telegram notification chat for a creator
▶CRM integrations
POSTCreate a creator account for your appNewGETGet accounts for your app (cursor-paginated)NewGETGet an account for your appNewPOSTCreate an ID-check link for an accountNewGETGet the webhook endpoint for your appNewPUTUpdate the webhook endpoint for your appNewDELDelete the webhook endpoint for your appNewPOSTRotate the webhook signing secret for your appNewPOSTSend a test webhook event for your appNewGETGet details for your appNewGETGet dashboard stats for your appNewGETGet sales for your app (cursor-paginated)NewGETGet connected accounts for your appNew
▶Pay to Chat
GETGet the Pay to Chat settingNewPUTChange the Pay to Chat settingNewPUTReport your bot as an account’s chatbotNewPOSTCheck a private messageNewPOSTReport an ask as sent or failedNewPOSTAsk a fan to pay nowNewGETGet the message and its linksNewPOSTOpen chats yourselfNewPOSTLook up fans’ chat statusNewPOSTEnd a conversationNewGETGet the Accept for listNewPUTReplace the Accept for listNew
▶Payouts
GETGet the payout summary for a creatorNewGETGet payouts for a creator (cursor-paginated)NewGETGet a payout for a creatorNewGETGet payout methods for a creatorNewPOSTCreate a Paxum payout method for a creatorNewPATCHUpdate a payout method for a creatorNewDELDelete a payout method for a creatorNewGETGet the MassPay profile for a creatorNewPOSTCreate the MassPay profile for a creatorNewGETGet MassPay wallet activation for a creatorNewPOSTCreate a payout request for a creatorNewPOSTCancel a payout request for a creatorNew
Resources
ChangelogAPI terms & acceptable use
Developers/API reference/Check a private message
API reference

Check a private message

Call it for every private message to an account whose chatbot is your bot, and with `from: "account"` for messages written from the account.

View as MarkdownUpdated Nov 12, 2026
← Previous
Report your bot as an account’s chatbot
Next →
Report an ask as sent or failed

Questions? [email protected]

On this page
  • Authentication
  • Request body
  • Responses
  • Errors
  • Rate limiting
  • Code samples

Let your fans show their appreciation.

Become a creatorSign up as a fan

Company

  • Blog
  • About
  • Help & FAQ
  • Availability
  • For Creators
  • Developers

Policy

  • Terms
  • Privacy
  • Refunds
  • DMCA
  • Complaints
  • USC 2257
  • AI Content
  • Cookies

Socials

Dropfans

© 2026 Dropfans. All rights reserved.

Dropfans is operated by KVIQVIEW AB, Reg. No. 559552-3852, Gamla Låssbyvägen 27, Gothenburg, Sweden.

POST/api/external/v1/chat-gate/checkalso served at /api/external/chat-gate/checkNew

Call it for every private message to an account whose chatbot is your bot, and with from: "account" for messages written from the account.

On action: "ask" send ask.text with ask.replyMarkup (plain text, no parse_mode) through the business connection, pin it silently, unpin ask.unpinMessageId and report the sent message to POST /chat-gate/asks/{id}. The ask is already claimed: until you report it failed, the fan isn’t asked again for 12 hours.

locked says the fan would have to pay: keep automated replies out of the chat. On a timeout or 5xx, let the message stand. See Pay to Chat from your own chatbot.

Send service: true for service messages (something was pinned, the history was cleared): Telegram shows your own pin as a message from the account, and without the flag it would silence the gate for 12 hours. dryRun: true decides without changing anything, for comparing our answer with a gate you already run.

Authentication

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/check — 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.

Request body

Content type: application/json

NameTypeRequiredDescription
accountstringRequiredTelegram user id of the creator’s account (the business connection’s user.id).
fanstringRequiredTelegram user id of the fan (the private chat’s id).
fromstringOptionalaccount for a message written from the account itself: nobody is asked in that chat for 12 hours.
One of: fan, account
Default: "fan"
servicebooleanOptionalA service message (a pin notice and the like), whoever it is from: never asks and never counts as the account writing. reason is service.
dryRunbooleanOptionalDecide only: no ask is claimed, nothing is stamped, and ask is null even when action is ask. The response carries dryRun: true.
languageCodestringOptionalThe fan’s Telegram language_code, for the ask’s language.
offlinebooleanOptionalAn away, greeting or scheduled message (is_from_offline): not someone talking.
quietbooleanOptionalA person has this chat: never ask (locked is still reported).
accountNamestringOptionalThe account’s first name for the ask; defaults to the one you reported.
A fan writes
{
  "account": "5550001111",
  "fan": "48213377",
  "from": "fan",
  "languageCode": "en"
}

Responses

200What to do.
NameTypeDescription
dryRunbooleanOnly on a dry run: true.
modestringWho may chat: everyone, fans who paid (tip or drop) or subscribed, or subscribers only.
One of: EVERYONE, PAY, SUB
payScopestringPay 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
sourcestringaccount: that Telegram account has its own setting; creator: the creator’s applies.
One of: account, creator
statusstringopen 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
lockedbooleanThe fan would have to pay: keep automated replies out.
actionstringSend the ask, or nothing.
One of: none, ask
reasonstringWhy.
One of: asked, mode_off, no_subscription_on_sale, not_locked, account_wrote, self, service, quiet, creator_talking, asked_recently, no_username
askobject | nullSet on action: "ask", except on a dry run.
Show child attributes
idstringReport the sent ask by it.
textstringSend as plain text.
replyMarkupobjectA Bot API InlineKeyboardMarkup with URL buttons into the Dropfans Mini App.
pinbooleanAlways true: pin it silently.
unpinMessageIdinteger | nullThe earlier ask pinned in this chat: unpin it.
localestringThe language the ask is in.
Example response
{
  "mode": "PAY",
  "payScope": "ONCE",
  "source": "creator",
  "status": "locked",
  "locked": true,
  "action": "ask",
  "reason": "asked",
  "ask": {
    "id": "ask_3f2a9c1d0b8e7f6a5c4d3e2f",
    "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": null,
    "locale": "en"
  }
}

Errors

StatusBodyWhen
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.
400{"error":"from must be 'fan' or 'account'","code":"invalid_request"}A bad `from`.
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).

Rate limiting

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.

Code samples

curl -X POST "https://www.dropfans.io/api/external/v1/chat-gate/check" \
  -H "Authorization: Bearer $DROPFANS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "account": "5550001111",
  "fan": "48213377",
  "from": "fan",
  "languageCode": "en"
}'
const res = await fetch(`https://www.dropfans.io/api/external/v1/chat-gate/check`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "account": "5550001111",
    "fan": "48213377",
    "from": "fan",
    "languageCode": "en"
  }),
});
console.log(await res.json());
import os
import requests

res = requests.post(
    "https://www.dropfans.io/api/external/v1/chat-gate/check",
    headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
    json={
        "account": "5550001111",
        "fan": "48213377",
        "from": "fan",
        "languageCode": "en",
    },
)
print(res.json())