Subscribers
Manage subscriber list and their tags.
GET /v1/subscribers
Project subscriber list. Pagination via query parameters.
limit number Number of records (default 50, max 200)
offset number Offset from the beginning of the list (default 0)
channel string Filter by channel: telegram or max
Response
username is stored and returned without the @ prefix (e.g. johndoe, not @johndoe). Empty string if the user has no username.
lang is a two-letter language code per ISO 639-1 (ru, en). Detected from the messenger UI language at subscription time.
PUT /v1/subscribers/:id/tags
Update subscriber tags. Pass the full array of tags. Tags must be pre-created in project settings or via API. Unknown tags will be auto-created (if the 20-tag limit is not reached).
Response
GET /v1/subscribe-link
A permanent deeplink for plain subscription to the project, for Telegram and Max. Optional query parameters permission and tag are added to the payload — when the subscriber follows the link they immediately receive the chosen permission and/or tag. telegram_link or max_link is null if the corresponding bot is not configured.
permission string Permission key granted to the subscriber on follow (latin letters, digits, hyphen; 1-64 chars). Must exist in the project, otherwise 400.
tag string Tag assigned to the subscriber on follow (latin letters, digits, hyphen; 1-64 chars). Must exist in the project, otherwise 400.
Response
How to find available values
permission and tag must be created in the project beforehand — otherwise the endpoint returns 400. To get the list of available values, first call GET /v1/permissions and GET /v1/tags, then pass the keys you need into GET /v1/subscribe-link.