# Zenedu API

- [Zenedu API](https://api.zenedu.io/index.md): API documentation for the Zenedu educational platform
- [Authentication](https://api.zenedu.io/authentication.md): How to authenticate with the Zenedu API
- [Errors](https://api.zenedu.io/errors.md): Error codes and handling in the Zenedu API
- [Build a course in the miniApp](https://api.zenedu.io/guides/miniapp-course.md): Create a lesson-based course for the miniApp and the web version: lessons, videos, materials, sections, and opening schedule
- [Build a course in a bot](https://api.zenedu.io/guides/bot-course.md): Create a step-by-step Telegram course with lessons, media, quizzes, and assignments
- [Give access to a product](https://api.zenedu.io/guides/product-access.md): Grant a subscriber access to a product through an offer, check their progress, and restart
- [API v1](https://api.zenedu.io/api-reference/introduction.md): Zenedu REST API for managing bots, subscribers, products, funnels, offers, and orders
- [Get current user](https://api.zenedu.io/api-reference/user/me.md): Returns the authenticated user's profile
- [List all bots](https://api.zenedu.io/api-reference/bots/list.md): Returns all bots of the authenticated account, newest first
- [Get bot](https://api.zenedu.io/api-reference/bots/get.md): Returns a single bot
- [Create bot](https://api.zenedu.io/api-reference/bots/create.md): Connects a new bot by its BotFather token
- [Activate bot](https://api.zenedu.io/api-reference/bots/activate.md): Turns the bot on
- [Enable commands menu](https://api.zenedu.io/api-reference/bots/enable-menu.md): Turns on the commands menu of the bot
- [Update bot](https://api.zenedu.io/api-reference/bots/update.md): Updates only the passed general settings of the bot
- [Deactivate bot](https://api.zenedu.io/api-reference/bots/deactivate.md): Turns the bot off
- [Disable commands menu](https://api.zenedu.io/api-reference/bots/disable-menu.md): Turns off the commands menu of the bot
- [Get bot settings](https://api.zenedu.io/api-reference/bot-settings/get.md): Returns the full settings for the specified bot
- [Upload email logo](https://api.zenedu.io/api-reference/bot-settings/upload-email-logo.md): Uploads the logo shown in emails (jpg, jpeg, png, up to 2 MB)
- [Save legal document](https://api.zenedu.io/api-reference/bot-settings/save-legal.md): Creates or updates a privacy policy or terms of service document
- [Update email settings](https://api.zenedu.io/api-reference/bot-settings/update-email.md): Updates the bot's email sender settings
- [Update branding](https://api.zenedu.io/api-reference/bot-settings/update-branding.md): Updates the bot's branding, theme, and button color
- [Update integrations](https://api.zenedu.io/api-reference/bot-settings/update-integrations.md): Updates analytics and tracking integrations
- [Delete email logo](https://api.zenedu.io/api-reference/bot-settings/delete-email-logo.md): Removes the email logo
- [Disconnect Google Sheets](https://api.zenedu.io/api-reference/bot-settings/disconnect-google-sheets.md): Disconnects the Google Sheets integration
- [Remove Google Sheets spreadsheet](https://api.zenedu.io/api-reference/bot-settings/remove-google-sheets-spreadsheet.md): Removes a linked Google Sheets spreadsheet
- [List subscribers](https://api.zenedu.io/api-reference/subscribers/list.md): Returns a paginated list of subscribers for the specified bot, newest first (Pro)
- [Get subscriber](https://api.zenedu.io/api-reference/subscribers/get.md): Returns a single subscriber by ID (Pro)
- [Update notes](https://api.zenedu.io/api-reference/subscribers/update-notes.md): Replaces the notes of a subscriber (Pro)
- [Add tags](https://api.zenedu.io/api-reference/subscribers/add-tags.md): Adds tags to a subscriber, creating missing tags in the bot (Pro)
- [Send message](https://api.zenedu.io/api-reference/subscribers/send-message.md): Sends a text message to a subscriber via Telegram (Pro)
- [Block subscriber](https://api.zenedu.io/api-reference/subscribers/block.md): Blocks a subscriber
- [Set custom field value](https://api.zenedu.io/api-reference/subscribers/set-custom-field.md): Sets the value of a custom field for a subscriber
- [Replace subscriber tags](https://api.zenedu.io/api-reference/subscribers/set-tags.md): Replaces the full tag list of a subscriber
- [Update subscriber](https://api.zenedu.io/api-reference/subscribers/update.md): Updates name, contacts and notes of a subscriber
- [Unblock subscriber](https://api.zenedu.io/api-reference/subscribers/unblock.md): Unblocks a subscriber
- [Delete subscriber](https://api.zenedu.io/api-reference/subscribers/delete.md): Deletes a subscriber from the bot
- [Add offer](https://api.zenedu.io/api-reference/subscribers/add-offer.md): Grants an offer to a subscriber by running it in the API channel (Pro)
- [Grant offer](https://api.zenedu.io/api-reference/subscribers/grant-offer.md): Grants an offer to a subscriber, optionally creating an order
- [Revoke offer access](https://api.zenedu.io/api-reference/subscribers/revoke-offer.md): Removes the subscriber's active access to all products and resources granted by the offer (Pro)
- [List subscriber products](https://api.zenedu.io/api-reference/subscribers/list-products.md): Returns the products the subscriber participates in, with progress and access
- [Update product access time](https://api.zenedu.io/api-reference/subscribers/update-product-access.md): Sets how long the subscriber has access to the product: unlimited, closed, for N days or until a date
- [Activate subscriber in product](https://api.zenedu.io/api-reference/subscribers/activate-product.md): Resumes the subscriber's participation in the product
- [Set open lessons of product](https://api.zenedu.io/api-reference/subscribers/set-product-lessons.md): Sets which lessons are opened to the subscriber manually
- [Set open menu steps of product](https://api.zenedu.io/api-reference/subscribers/set-product-menu.md): Sets which menu steps are opened to the subscriber manually
- [Stop subscriber in product](https://api.zenedu.io/api-reference/subscribers/stop-product.md): Stops the subscriber's participation in the product
- [Delete progress step of product](https://api.zenedu.io/api-reference/subscribers/delete-product-progress-step.md): Removes a completed step from the subscriber's progress in the product
- [Remove subscriber from product](https://api.zenedu.io/api-reference/subscribers/remove-product.md): Removes the subscriber from the product
- [List subscriber funnels](https://api.zenedu.io/api-reference/subscribers/list-funnels.md): Returns the funnels the subscriber participates in, with progress and access
- [Add to funnel (by body)](https://api.zenedu.io/api-reference/subscribers/add-funnel.md): Adds a subscriber to a funnel (Pro)
- [Add subscriber to funnel](https://api.zenedu.io/api-reference/subscribers/join-funnel.md): Adds the subscriber to the funnel
- [Update funnel access time](https://api.zenedu.io/api-reference/subscribers/update-funnel-access.md): Sets how long the subscriber has access to the funnel: unlimited, closed, for N days or until a date
- [Activate subscriber in funnel](https://api.zenedu.io/api-reference/subscribers/activate-funnel.md): Resumes the subscriber's participation in the funnel
- [Set open lessons of funnel](https://api.zenedu.io/api-reference/subscribers/set-funnel-lessons.md): Sets which lessons are opened to the subscriber manually
- [Set open menu steps of funnel](https://api.zenedu.io/api-reference/subscribers/set-funnel-menu.md): Sets which menu steps are opened to the subscriber manually
- [Stop subscriber in funnel](https://api.zenedu.io/api-reference/subscribers/stop-funnel.md): Stops the subscriber's participation in the funnel
- [Delete progress step of funnel](https://api.zenedu.io/api-reference/subscribers/delete-funnel-progress-step.md): Removes a completed step from the subscriber's progress in the funnel
- [Remove subscriber from funnel](https://api.zenedu.io/api-reference/subscribers/remove-funnel.md): Removes the subscriber from the funnel
- [Update channel access time](https://api.zenedu.io/api-reference/subscribers/update-channel-access.md): Sets how long the subscriber has access to the channel: unlimited, closed, for N days or until a date
- [Remove subscriber from channel](https://api.zenedu.io/api-reference/subscribers/remove-channel.md): Removes the subscriber from the channel
- [Update group access time](https://api.zenedu.io/api-reference/subscribers/update-group-access.md): Sets how long the subscriber has access to the group: unlimited, closed, for N days or until a date
- [Remove subscriber from group](https://api.zenedu.io/api-reference/subscribers/remove-group.md): Removes the subscriber from the group
- [List orders](https://api.zenedu.io/api-reference/orders/list.md): Returns a paginated list of orders for the specified bot.
- [Get order](https://api.zenedu.io/api-reference/orders/get.md): Returns a single order by ID.
- [Cancel order](https://api.zenedu.io/api-reference/orders/cancel.md): Cancels an order.
- [Refund order](https://api.zenedu.io/api-reference/orders/refund.md): Refunds a paid order.
- [Confirm order](https://api.zenedu.io/api-reference/orders/confirm.md): Confirms an unconfirmed order.
- [Delete order](https://api.zenedu.io/api-reference/orders/delete.md): Deletes an order.
- [List products](https://api.zenedu.io/api-reference/products/list.md): Returns a paginated list of products for the specified bot.
- [Get product](https://api.zenedu.io/api-reference/products/get.md): Returns a single product.
- [List product subscribers](https://api.zenedu.io/api-reference/products/subscribers.md): Returns a paginated list of the product's subscribers, newest first.
- [Create product](https://api.zenedu.io/api-reference/products/create.md): Creates a product. Optionally attaches an existing offer (offer_id) or creates a new one (offer).
- [Duplicate product](https://api.zenedu.io/api-reference/products/duplicate.md): Creates a copy of a product in the same bot, or in another bot of the account when into_bot_id is passed.
- [Upload product cover](https://api.zenedu.io/api-reference/products/update-cover.md): Uploads or replaces the product cover image.
- [Upload invite image](https://api.zenedu.io/api-reference/products/update-invite-image.md): Uploads or replaces the invite image.
- [Attach offer](https://api.zenedu.io/api-reference/products/attach-offer.md): Adds the product to an offer.
- [Resume finished subscribers](https://api.zenedu.io/api-reference/products/resume-subscribers.md): Resumes subscribers who have finished the product.
- [Activate product](https://api.zenedu.io/api-reference/products/activate.md): Activates a product.
- [Update product invite](https://api.zenedu.io/api-reference/products/update-invite.md): Sets the invitation message the subscriber receives when added to the product.
- [Update product](https://api.zenedu.io/api-reference/products/update.md): Partially updates a product; only the passed fields change.
- [Stop product](https://api.zenedu.io/api-reference/products/stop.md): Stops (deactivates) a product.
- [Delete product cover](https://api.zenedu.io/api-reference/products/delete-cover.md): Removes the product cover image.
- [Delete invite image](https://api.zenedu.io/api-reference/products/delete-invite-image.md): Removes the invite image.
- [Detach offer](https://api.zenedu.io/api-reference/products/detach-offer.md): Removes the product from an offer.
- [Delete product](https://api.zenedu.io/api-reference/products/delete.md): Deletes a product.
- [List lessons](https://api.zenedu.io/api-reference/products/lessons/list.md): Returns all lessons of a mini-app product in order.
- [Get lesson](https://api.zenedu.io/api-reference/products/lessons/get.md): Returns a single lesson.
- [Create lesson](https://api.zenedu.io/api-reference/products/lessons/create.md): Creates a lesson in a mini-app product.
- [Duplicate lesson](https://api.zenedu.io/api-reference/products/lessons/duplicate.md): Creates a copy of the lesson.
- [Upload lesson cover](https://api.zenedu.io/api-reference/products/lessons/update-cover.md): Uploads or replaces the lesson cover image.
- [Upload lesson-open image](https://api.zenedu.io/api-reference/products/lessons/update-open-image.md): Uploads or replaces the image of the lesson-open notification.
- [Reorder lessons](https://api.zenedu.io/api-reference/products/lessons/reorder.md): Sets the lesson order; returns the lessons in the new order.
- [Activate lesson](https://api.zenedu.io/api-reference/products/lessons/activate.md): Makes the lesson active.
- [Update lesson](https://api.zenedu.io/api-reference/products/lessons/update.md): Partially updates a lesson; only the passed fields change.
- [Deactivate lesson](https://api.zenedu.io/api-reference/products/lessons/deactivate.md): Makes the lesson inactive.
- [Delete lesson cover](https://api.zenedu.io/api-reference/products/lessons/delete-cover.md): Removes the lesson cover image.
- [Delete lesson-open image](https://api.zenedu.io/api-reference/products/lessons/delete-open-image.md): Removes the image of the lesson-open notification.
- [Delete lesson](https://api.zenedu.io/api-reference/products/lessons/delete.md): Deletes a lesson.
- [List lesson materials](https://api.zenedu.io/api-reference/products/lessons/materials/list.md): Returns the materials of a lesson: files and links.
- [Add lesson material](https://api.zenedu.io/api-reference/products/lessons/materials/create.md): Adds a file (multipart/form-data) or an external link (JSON) to a lesson.
- [Reorder lesson materials](https://api.zenedu.io/api-reference/products/lessons/materials/reorder.md): Sets the material order; returns the materials in the new order.
- [Update lesson material](https://api.zenedu.io/api-reference/products/lessons/materials/update.md): Renames a material or changes the URL of a link material. A link requires a name, and url applies to links only.
- [Delete lesson material](https://api.zenedu.io/api-reference/products/lessons/materials/delete.md): Deletes a material from a lesson.
- [Get lesson video](https://api.zenedu.io/api-reference/products/lessons/video/get.md): Returns the video attached to a lesson.
- [Create video upload](https://api.zenedu.io/api-reference/products/lessons/video/create-upload.md): Registers a video upload and returns TUS credentials. The file is uploaded by the client directly to the video host; then call Complete video upload.
- [Complete video upload](https://api.zenedu.io/api-reference/products/lessons/video/complete-upload.md): Marks an uploaded video as received after the TUS upload finishes; the video moves from uploading to processing.
- [Attach external video](https://api.zenedu.io/api-reference/products/lessons/video/attach-external.md): Attaches an external video (YouTube, Vimeo, Bunny) to a lesson by URL.
- [Delete lesson video](https://api.zenedu.io/api-reference/products/lessons/video/delete.md): Detaches and deletes the lesson video.
- [List product sections](https://api.zenedu.io/api-reference/products/sections/list.md): Returns all sections of the product. The list is not paginated.
- [Create product section](https://api.zenedu.io/api-reference/products/sections/create.md): Creates a section in the product.
- [Reorder product sections](https://api.zenedu.io/api-reference/products/sections/reorder.md): Sets the order of sections. Returns the full list in the new order.
- [Update product section](https://api.zenedu.io/api-reference/products/sections/update.md): Partially updates the section.
- [Delete product section](https://api.zenedu.io/api-reference/products/sections/delete.md): Deletes the section.
- [List product steps](https://api.zenedu.io/api-reference/products/steps/list.md): Returns all steps of the product ordered by sort. The list is not paginated.
- [Get product step](https://api.zenedu.io/api-reference/products/steps/get.md): Returns a single step of the product with buttons and options.
- [Create product step](https://api.zenedu.io/api-reference/products/steps/create.md): Creates a step in the product. Attachments cannot be set via the API.
- [Duplicate product step](https://api.zenedu.io/api-reference/products/steps/duplicate.md): Duplicates the step within the same product or into another one.
- [Upload step cover](https://api.zenedu.io/api-reference/products/steps/update-cover.md): Uploads or replaces the step cover image. Allowed formats: jpg, jpeg, png, webp, up to 20 MB.
- [Create step button](https://api.zenedu.io/api-reference/products/steps/create-button.md): Adds an inline button to the end of the step's button list. Returns the updated step.
- [Reorder product steps](https://api.zenedu.io/api-reference/products/steps/reorder.md): Sets the order of steps in the product. Returns the full list in the new order.
- [Activate product step](https://api.zenedu.io/api-reference/products/steps/activate.md): Activates the step.
- [Reorder step buttons](https://api.zenedu.io/api-reference/products/steps/reorder-buttons.md): Sets the order of the step's inline buttons. Returns the updated step.
- [Update product step](https://api.zenedu.io/api-reference/products/steps/update.md): Partially updates a step. Only the passed fields are changed.
- [Update step menu time](https://api.zenedu.io/api-reference/products/steps/update-menu-time.md): Sets when the step becomes available in the bot menu.
- [Update step sending time](https://api.zenedu.io/api-reference/products/steps/update-sending-time.md): Sets when the step is sent to the subscriber.
- [Update step button](https://api.zenedu.io/api-reference/products/steps/update-button.md): Replaces the button's fields. All fields are saved, so pass the full button. Returns the updated step.
- [Deactivate product step](https://api.zenedu.io/api-reference/products/steps/deactivate.md): Stops the step.
- [Delete step cover](https://api.zenedu.io/api-reference/products/steps/delete-cover.md): Removes the step cover image.
- [Delete step button](https://api.zenedu.io/api-reference/products/steps/delete-button.md): Deletes the button. Returns the updated step.
- [Delete product step](https://api.zenedu.io/api-reference/products/steps/delete.md): Deletes the step.
- [Delete step attachment](https://api.zenedu.io/api-reference/products/steps/delete-attachment.md): Removes a file attachment from a product step
- [List funnels](https://api.zenedu.io/api-reference/funnels/list.md): Returns a paginated list of funnels for the specified bot.
- [Get funnel](https://api.zenedu.io/api-reference/funnels/get.md): Returns a single funnel.
- [List funnel subscribers](https://api.zenedu.io/api-reference/funnels/subscribers.md): Returns a paginated list of funnel subscribers, newest first, with their access state.
- [Create funnel](https://api.zenedu.io/api-reference/funnels/create.md): Creates a funnel in the bot.
- [Convert funnel to product](https://api.zenedu.io/api-reference/funnels/convert.md): Converts a funnel into a product. Entry points that no longer apply to a product (direct subscription, access after finishing another funnel, add-to-funnel buttons) are removed.
- [Duplicate funnel](https://api.zenedu.io/api-reference/funnels/duplicate.md): Creates a copy of the funnel, in the same bot or in another bot of the account.
- [Update funnel cover](https://api.zenedu.io/api-reference/funnels/update-cover.md): Uploads a cover image for the funnel.
- [Attach offer to funnel](https://api.zenedu.io/api-reference/funnels/attach-offer.md): Adds the funnel to an offer.
- [Resume finished subscribers](https://api.zenedu.io/api-reference/funnels/resume-subscribers.md): Resumes subscribers who finished the funnel so they receive steps added later. Processing runs in the queue.
- [Activate funnel](https://api.zenedu.io/api-reference/funnels/activate.md): Activates a funnel.
- [Set start funnel](https://api.zenedu.io/api-reference/funnels/set-start.md): Makes the funnel the start funnel: subscribers join it on /start. The flag is removed from the previous start funnel, whose ID is returned as previous_funnel_id.
- [Update funnel](https://api.zenedu.io/api-reference/funnels/update.md): Partially updates a funnel: only the passed fields are changed.
- [Stop funnel](https://api.zenedu.io/api-reference/funnels/stop.md): Stops a funnel.
- [Delete funnel cover](https://api.zenedu.io/api-reference/funnels/delete-cover.md): Removes the funnel cover image.
- [Detach offer from funnel](https://api.zenedu.io/api-reference/funnels/detach-offer.md): Removes the funnel from an offer.
- [Unset start funnel](https://api.zenedu.io/api-reference/funnels/unset-start.md): Removes the start funnel flag from the funnel.
- [Delete funnel](https://api.zenedu.io/api-reference/funnels/delete.md): Deletes a funnel.
- [List funnel links](https://api.zenedu.io/api-reference/funnels/links/list.md): Returns the funnel links, newest first. The list is not paginated.
- [Create funnel link](https://api.zenedu.io/api-reference/funnels/links/create.md): Creates a link for the funnel.
- [Update funnel link](https://api.zenedu.io/api-reference/funnels/links/update.md): Updates a funnel link. The link fields are replaced as in create, so name is required.
- [Delete funnel link](https://api.zenedu.io/api-reference/funnels/links/delete.md): Deletes a funnel link.
- [List funnel sections](https://api.zenedu.io/api-reference/funnels/sections/list.md): Returns all sections of the funnel. The list is not paginated.
- [Create funnel section](https://api.zenedu.io/api-reference/funnels/sections/create.md): Creates a section in the funnel.
- [Reorder funnel sections](https://api.zenedu.io/api-reference/funnels/sections/reorder.md): Sets the order of sections. Returns the full list in the new order.
- [Update funnel section](https://api.zenedu.io/api-reference/funnels/sections/update.md): Partially updates the section.
- [Delete funnel section](https://api.zenedu.io/api-reference/funnels/sections/delete.md): Deletes the section.
- [List funnel steps](https://api.zenedu.io/api-reference/funnels/steps/list.md): Returns all steps of the funnel ordered by sort. The list is not paginated.
- [Get funnel step](https://api.zenedu.io/api-reference/funnels/steps/get.md): Returns a single step of the funnel with buttons and options.
- [Create funnel step](https://api.zenedu.io/api-reference/funnels/steps/create.md): Creates a step in the funnel. Attachments cannot be set via the API.
- [Duplicate funnel step](https://api.zenedu.io/api-reference/funnels/steps/duplicate.md): Duplicates the step within the same funnel or into another one.
- [Upload step cover](https://api.zenedu.io/api-reference/funnels/steps/update-cover.md): Uploads or replaces the step cover image. Allowed formats: jpg, jpeg, png, webp, up to 20 MB.
- [Create step button](https://api.zenedu.io/api-reference/funnels/steps/create-button.md): Adds an inline button to the end of the step's button list. Returns the updated step.
- [Reorder funnel steps](https://api.zenedu.io/api-reference/funnels/steps/reorder.md): Sets the order of steps in the funnel. Returns the full list in the new order.
- [Activate funnel step](https://api.zenedu.io/api-reference/funnels/steps/activate.md): Activates the step.
- [Reorder step buttons](https://api.zenedu.io/api-reference/funnels/steps/reorder-buttons.md): Sets the order of the step's inline buttons. Returns the updated step.
- [Update funnel step](https://api.zenedu.io/api-reference/funnels/steps/update.md): Partially updates a step. Only the passed fields are changed.
- [Update step menu time](https://api.zenedu.io/api-reference/funnels/steps/update-menu-time.md): Sets when the step becomes available in the bot menu.
- [Update step sending time](https://api.zenedu.io/api-reference/funnels/steps/update-sending-time.md): Sets when the step is sent to the subscriber.
- [Update step button](https://api.zenedu.io/api-reference/funnels/steps/update-button.md): Replaces the button's fields. All fields are saved, so pass the full button. Returns the updated step.
- [Deactivate funnel step](https://api.zenedu.io/api-reference/funnels/steps/deactivate.md): Stops the step.
- [Delete step cover](https://api.zenedu.io/api-reference/funnels/steps/delete-cover.md): Removes the step cover image.
- [Delete step button](https://api.zenedu.io/api-reference/funnels/steps/delete-button.md): Deletes the button. Returns the updated step.
- [Delete funnel step](https://api.zenedu.io/api-reference/funnels/steps/delete.md): Deletes the step.
- [Delete step attachment](https://api.zenedu.io/api-reference/funnels/steps/delete-attachment.md): Removes a file attachment from a funnel step
- [List offers](https://api.zenedu.io/api-reference/offers/list.md): Returns a paginated list of offers for the specified bot
- [Get offer](https://api.zenedu.io/api-reference/offers/get.md): Returns a single offer
- [List offer subscribers](https://api.zenedu.io/api-reference/offers/subscribers.md): Returns a paginated list of subscribers who currently have access through the offer
- [Create offer](https://api.zenedu.io/api-reference/offers/create.md): Creates an offer
- [Duplicate offer](https://api.zenedu.io/api-reference/offers/duplicate.md): Creates a copy of an offer
- [Activate offer](https://api.zenedu.io/api-reference/offers/activate.md): Activates an offer
- [Update offer](https://api.zenedu.io/api-reference/offers/update.md): Partially updates an offer; only passed fields are changed
- [Stop offer](https://api.zenedu.io/api-reference/offers/deactivate.md): Stops an offer so it can no longer be purchased
- [Delete offer](https://api.zenedu.io/api-reference/offers/delete.md): Deletes an offer
- [Upload offer cover image](https://api.zenedu.io/api-reference/offers/update-cover.md): Uploads or replaces the offer cover image
- [Upload offer bot message image](https://api.zenedu.io/api-reference/offers/update-bot-image.md): Uploads or replaces the offer bot message image
- [Upload offer thank-you image](https://api.zenedu.io/api-reference/offers/update-thankyou-image.md): Uploads or replaces the offer thank-you image
- [Delete offer cover image](https://api.zenedu.io/api-reference/offers/delete-cover.md): Removes the offer cover image
- [Delete offer bot message image](https://api.zenedu.io/api-reference/offers/delete-bot-image.md): Removes the offer bot message image
- [Delete offer thank-you image](https://api.zenedu.io/api-reference/offers/delete-thankyou-image.md): Removes the offer thank-you image
- [List offer links](https://api.zenedu.io/api-reference/offers/links/list.md): Returns links created by the owner for the offer, newest first
- [Create offer link](https://api.zenedu.io/api-reference/offers/links/create.md): Creates a payment link for the offer
- [Update offer link](https://api.zenedu.io/api-reference/offers/links/update.md): Updates an offer link
- [Delete offer link](https://api.zenedu.io/api-reference/offers/links/delete.md): Deletes an offer link
- [List payment methods](https://api.zenedu.io/api-reference/payment-systems/list.md): Returns all payment methods of the account
- [List payment method types](https://api.zenedu.io/api-reference/payment-systems/types.md): Returns payment method types and the settings each accepts
- [Get payment method](https://api.zenedu.io/api-reference/payment-systems/get.md): Returns a single payment method by ID
- [Create payment method](https://api.zenedu.io/api-reference/payment-systems/create.md): Creates a payment method for the account
- [Update payment method](https://api.zenedu.io/api-reference/payment-systems/update.md): Partially updates a payment method
- [Reorder payment methods](https://api.zenedu.io/api-reference/payment-systems/reorder.md): Sets the display order of payment methods
- [Delete payment method](https://api.zenedu.io/api-reference/payment-systems/delete.md): Deletes a payment method
- [Generate offer link](https://api.zenedu.io/api-reference/links/offer-link.md): Generates a payment link for an offer (Pro)
- [Generate funnel link](https://api.zenedu.io/api-reference/links/funnel-link.md): Generates an invite link for a funnel (Pro)
- [Get shop](https://api.zenedu.io/api-reference/shop/get.md): Returns the shop draft with its offers and publication status
- [Publish shop](https://api.zenedu.io/api-reference/shop/publish.md): Publishes the shop draft
- [Set shop offers](https://api.zenedu.io/api-reference/shop/set-offers.md): Sets the list of offers enabled in the shop draft
- [Reorder shop offers](https://api.zenedu.io/api-reference/shop/reorder.md): Sets the display order of offers in the shop draft
- [Enable shop offer](https://api.zenedu.io/api-reference/shop/enable-offer.md): Enables an offer in the shop draft
- [Disable shop offer](https://api.zenedu.io/api-reference/shop/disable-offer.md): Disables an offer in the shop draft
- [Unpublish shop](https://api.zenedu.io/api-reference/shop/unpublish.md): Unpublishes the shop
- [Get Telegram mini app](https://api.zenedu.io/api-reference/mini-app/get.md): Returns the draft of the Telegram mini app (settings, menu, profile items, onboarding) with publication status.
- [Upload logo](https://api.zenedu.io/api-reference/mini-app/update-logo.md): Uploads the logo of the Telegram mini app.
- [Publish Telegram mini app](https://api.zenedu.io/api-reference/mini-app/publish.md): Publishes the current draft of the Telegram mini app.
- [Update settings](https://api.zenedu.io/api-reference/mini-app/update-settings.md): Updates settings of the Telegram mini app draft.
- [Delete logo](https://api.zenedu.io/api-reference/mini-app/delete-logo.md): Removes the logo of the Telegram mini app draft.
- [Unpublish Telegram mini app](https://api.zenedu.io/api-reference/mini-app/unpublish.md): Unpublishes the Telegram mini app.
- [Create menu item](https://api.zenedu.io/api-reference/mini-app/create-menu-item.md): Adds a custom item to the menu of the Telegram mini app.
- [Move menu item](https://api.zenedu.io/api-reference/mini-app/move-menu-item.md): Moves the item to the profile.
- [Reorder menu items](https://api.zenedu.io/api-reference/mini-app/reorder-menu-items.md): Sets the order of menu items.
- [Update menu item](https://api.zenedu.io/api-reference/mini-app/update-menu-item.md): Updates a menu item of the Telegram mini app.
- [Delete menu item](https://api.zenedu.io/api-reference/mini-app/delete-menu-item.md): Deletes a menu item.
- [Create profile item](https://api.zenedu.io/api-reference/mini-app/create-profile-item.md): Adds a custom item to the profile of the Telegram mini app.
- [Move profile item](https://api.zenedu.io/api-reference/mini-app/move-profile-item.md): Moves the item to the menu.
- [Reorder profile items](https://api.zenedu.io/api-reference/mini-app/reorder-profile-items.md): Sets the order of profile items.
- [Update profile item](https://api.zenedu.io/api-reference/mini-app/update-profile-item.md): Updates a profile item of the Telegram mini app.
- [Delete profile item](https://api.zenedu.io/api-reference/mini-app/delete-profile-item.md): Deletes a profile item.
- [Create onboarding screen](https://api.zenedu.io/api-reference/mini-app/create-onboarding.md): Adds an onboarding screen to the mini app.
- [Update onboarding image](https://api.zenedu.io/api-reference/mini-app/update-onboarding-image.md): Replaces the image of an onboarding screen.
- [Reorder onboarding screens](https://api.zenedu.io/api-reference/mini-app/reorder-onboarding.md): Sets the order of onboarding screens.
- [Update onboarding screen](https://api.zenedu.io/api-reference/mini-app/update-onboarding.md): Updates texts of an onboarding screen.
- [Delete onboarding screen](https://api.zenedu.io/api-reference/mini-app/delete-onboarding.md): Deletes an onboarding screen.
- [Get web app](https://api.zenedu.io/api-reference/web/get.md): Returns the draft of the web app (settings, menu, profile items, address) with publication status.
- [Upload logo](https://api.zenedu.io/api-reference/web/update-logo.md): Uploads the logo of the web app.
- [Upload favicon](https://api.zenedu.io/api-reference/web/update-favicon.md): Uploads the favicon of the web app.
- [Publish web app](https://api.zenedu.io/api-reference/web/publish.md): Publishes the current draft of the web app.
- [Update settings](https://api.zenedu.io/api-reference/web/update-settings.md): Updates settings of the web app draft.
- [Update address](https://api.zenedu.io/api-reference/web/update-address.md): Changes the web handle and toggles the custom domain.
- [Delete logo](https://api.zenedu.io/api-reference/web/delete-logo.md): Removes the logo of the web app draft.
- [Unpublish web app](https://api.zenedu.io/api-reference/web/unpublish.md): Unpublishes the web app.
- [Create menu item](https://api.zenedu.io/api-reference/web/create-menu-item.md): Adds a custom item to the menu of the web app.
- [Move menu item](https://api.zenedu.io/api-reference/web/move-menu-item.md): Moves the item to the profile.
- [Reorder menu items](https://api.zenedu.io/api-reference/web/reorder-menu-items.md): Sets the order of menu items.
- [Update menu item](https://api.zenedu.io/api-reference/web/update-menu-item.md): Updates a menu item of the web app.
- [Delete menu item](https://api.zenedu.io/api-reference/web/delete-menu-item.md): Deletes a menu item.
- [Create profile item](https://api.zenedu.io/api-reference/web/create-profile-item.md): Adds a custom item to the profile of the web app.
- [Move profile item](https://api.zenedu.io/api-reference/web/move-profile-item.md): Moves the item to the menu.
- [Reorder profile items](https://api.zenedu.io/api-reference/web/reorder-profile-items.md): Sets the order of profile items.
- [Update profile item](https://api.zenedu.io/api-reference/web/update-profile-item.md): Updates a profile item of the web app.
- [Delete profile item](https://api.zenedu.io/api-reference/web/delete-profile-item.md): Deletes a profile item.
- [List subscriptions](https://api.zenedu.io/api-reference/subscriptions/list.md): Returns a paginated list of recurring subscriptions for the specified bot.
- [Get subscription](https://api.zenedu.io/api-reference/subscriptions/get.md): Returns a single subscription by ID.
- [Cancel subscription](https://api.zenedu.io/api-reference/subscriptions/cancel.md): Cancels a recurring subscription.
- [List coupons](https://api.zenedu.io/api-reference/coupons/list.md): Returns a paginated list of coupons for the bot
- [Get coupon](https://api.zenedu.io/api-reference/coupons/get.md): Returns a single coupon
- [Create coupon](https://api.zenedu.io/api-reference/coupons/create.md): Creates a coupon for one or more offers
- [Update coupon](https://api.zenedu.io/api-reference/coupons/update.md): Replaces all coupon fields; partial updates are not supported
- [Activate coupon](https://api.zenedu.io/api-reference/coupons/activate.md): Activates a coupon
- [Stop coupon](https://api.zenedu.io/api-reference/coupons/deactivate.md): Deactivates a coupon
- [Delete coupon](https://api.zenedu.io/api-reference/coupons/delete.md): Deletes a coupon
- [List tasks](https://api.zenedu.io/api-reference/tasks/list.md): Returns a paginated list of student tasks (homework) that have messages.
- [Approve task](https://api.zenedu.io/api-reference/tasks/approve.md): Approves a student task.
- [Delete task](https://api.zenedu.io/api-reference/tasks/delete.md): Deletes a student task.
- [List broadcasts](https://api.zenedu.io/api-reference/broadcasts/list.md): Returns a paginated list of broadcasts for the specified bot.
- [Get broadcast](https://api.zenedu.io/api-reference/broadcasts/get.md): Returns a single broadcast by ID.
- [Create broadcast](https://api.zenedu.io/api-reference/broadcasts/create.md): Creates a broadcast.
- [Send broadcast](https://api.zenedu.io/api-reference/broadcasts/send.md): Sends the broadcast now or schedules it.
- [Duplicate broadcast](https://api.zenedu.io/api-reference/broadcasts/duplicate.md): Creates a copy of the broadcast.
- [Update broadcast](https://api.zenedu.io/api-reference/broadcasts/update.md): Updates a broadcast.
- [Cancel broadcast send](https://api.zenedu.io/api-reference/broadcasts/cancel.md): Cancels a scheduled or in-progress broadcast.
- [Delete sent messages](https://api.zenedu.io/api-reference/broadcasts/delete-messages.md): Deletes the messages already sent by the broadcast from subscribers' chats.
- [Delete broadcast](https://api.zenedu.io/api-reference/broadcasts/delete.md): Deletes a broadcast.
- [Delete broadcast attachment](https://api.zenedu.io/api-reference/broadcasts/delete-attachment.md): Removes a file attachment from a broadcast
- [Create broadcast button](https://api.zenedu.io/api-reference/broadcasts/create-button.md): Adds a button to the broadcast.
- [Reorder broadcast buttons](https://api.zenedu.io/api-reference/broadcasts/reorder-buttons.md): Reorders the broadcast's buttons.
- [Update broadcast button](https://api.zenedu.io/api-reference/broadcasts/update-button.md): Updates a broadcast button.
- [Delete broadcast button](https://api.zenedu.io/api-reference/broadcasts/delete-button.md): Removes a button from the broadcast.
- [List automations](https://api.zenedu.io/api-reference/automations/list.md): Returns a paginated list of automations for the specified bot.
- [Get automation](https://api.zenedu.io/api-reference/automations/get.md): Returns a single automation by ID.
- [Get automation catalog](https://api.zenedu.io/api-reference/automations/catalog.md): Returns the available events and actions with their target fields.
- [Create automation](https://api.zenedu.io/api-reference/automations/create.md): Creates an automation.
- [Update automation](https://api.zenedu.io/api-reference/automations/update.md): Updates an automation.
- [Activate automation](https://api.zenedu.io/api-reference/automations/activate.md): Activates an automation.
- [Deactivate automation](https://api.zenedu.io/api-reference/automations/deactivate.md): Stops an automation.
- [Delete automation](https://api.zenedu.io/api-reference/automations/delete.md): Deletes an automation.
- [Get affiliate program](https://api.zenedu.io/api-reference/affiliate/get.md): Returns the bot's affiliate program.
- [Create affiliate program](https://api.zenedu.io/api-reference/affiliate/create.md): Creates the bot's affiliate program.
- [Update affiliate program](https://api.zenedu.io/api-reference/affiliate/update.md): Updates the bot's affiliate program.
- [List affiliate links](https://api.zenedu.io/api-reference/affiliate/list-links.md): Returns a paginated list of affiliate links with click, payment, and revenue stats.
- [Create affiliate link](https://api.zenedu.io/api-reference/affiliate/create-link.md): Creates an affiliate link.
- [Update affiliate link](https://api.zenedu.io/api-reference/affiliate/update-link.md): Updates an affiliate link.
- [Delete affiliate link](https://api.zenedu.io/api-reference/affiliate/delete-link.md): Deletes an affiliate link.
- [List affiliate partners](https://api.zenedu.io/api-reference/affiliate/list-partners.md): Returns a paginated list of partners with affiliate stats.
- [Pay out affiliate partner](https://api.zenedu.io/api-reference/affiliate/payout.md): Pays the partner's accumulated affiliate reward.
- [List affiliate payments](https://api.zenedu.io/api-reference/affiliate/payments.md): Returns a paginated list of affiliate commissions from referral orders.
- [List channels](https://api.zenedu.io/api-reference/channels/list.md): Returns a paginated list of the bot's channels
- [Get channel](https://api.zenedu.io/api-reference/channels/get.md): Returns a single channel
- [Confirm channel](https://api.zenedu.io/api-reference/channels/confirm.md): Confirms a channel the bot was added to
- [Activate channel](https://api.zenedu.io/api-reference/channels/activate.md): Activates the channel
- [Stop channel](https://api.zenedu.io/api-reference/channels/deactivate.md): Deactivates the channel
- [Delete channel](https://api.zenedu.io/api-reference/channels/delete.md): Deletes the channel
- [Upload channel invite image](https://api.zenedu.io/api-reference/channels/update-invite-image.md): Uploads the invite image for the channel
- [Update channel invite](https://api.zenedu.io/api-reference/channels/update-invite.md): Sets the invite message for the channel
- [Delete channel invite image](https://api.zenedu.io/api-reference/channels/delete-invite-image.md): Removes the invite image of the channel
- [Attach offer to channel](https://api.zenedu.io/api-reference/channels/attach-offer.md): Adds the channel to an offer
- [Detach offer from channel](https://api.zenedu.io/api-reference/channels/detach-offer.md): Removes the channel from an offer
- [List groups](https://api.zenedu.io/api-reference/groups/list.md): Returns a paginated list of the bot's groups
- [Get group](https://api.zenedu.io/api-reference/groups/get.md): Returns a single group
- [Confirm group](https://api.zenedu.io/api-reference/groups/confirm.md): Confirms a group the bot was added to
- [Activate group](https://api.zenedu.io/api-reference/groups/activate.md): Activates the group
- [Stop group](https://api.zenedu.io/api-reference/groups/deactivate.md): Deactivates the group
- [Delete group](https://api.zenedu.io/api-reference/groups/delete.md): Deletes the group
- [Upload group invite image](https://api.zenedu.io/api-reference/groups/update-invite-image.md): Uploads the invite image for the group
- [Update group invite](https://api.zenedu.io/api-reference/groups/update-invite.md): Sets the invite message for the group
- [Delete group invite image](https://api.zenedu.io/api-reference/groups/delete-invite-image.md): Removes the invite image of the group
- [Attach offer to group](https://api.zenedu.io/api-reference/groups/attach-offer.md): Adds the group to an offer
- [Detach offer from group](https://api.zenedu.io/api-reference/groups/detach-offer.md): Removes the group from an offer
- [List commands](https://api.zenedu.io/api-reference/commands/list.md): Returns bot commands in menu order
- [Create command](https://api.zenedu.io/api-reference/commands/create.md): Creates a menu command
- [Reorder commands](https://api.zenedu.io/api-reference/commands/reorder.md): Sets the order of commands
- [Update command](https://api.zenedu.io/api-reference/commands/update.md): Replaces command fields
- [Activate command](https://api.zenedu.io/api-reference/commands/activate.md): Turns the command on
- [Deactivate command](https://api.zenedu.io/api-reference/commands/deactivate.md): Turns the command off
- [Delete command](https://api.zenedu.io/api-reference/commands/delete.md): Deletes a command
- [List custom fields](https://api.zenedu.io/api-reference/custom-fields/list.md): Returns subscriber custom fields of the bot
- [Create custom field](https://api.zenedu.io/api-reference/custom-fields/create.md): Creates a subscriber custom field
- [Update custom field](https://api.zenedu.io/api-reference/custom-fields/update.md): Replaces custom field attributes
- [Delete custom field](https://api.zenedu.io/api-reference/custom-fields/delete.md): Deletes a custom field
- [List folders](https://api.zenedu.io/api-reference/folders/list.md): Returns bot folders sorted by name
- [Create folder](https://api.zenedu.io/api-reference/folders/create.md): Creates a folder
- [Rename folder](https://api.zenedu.io/api-reference/folders/update.md): Renames a folder
- [Delete folder](https://api.zenedu.io/api-reference/folders/delete.md): Deletes a folder
- [Move product to folder](https://api.zenedu.io/api-reference/folders/move-product.md): Moves a product into a folder
- [Move funnel to folder](https://api.zenedu.io/api-reference/folders/move-funnel.md): Moves a funnel into a folder
- [Move channel to folder](https://api.zenedu.io/api-reference/folders/move-channel.md): Moves a channel into a folder
- [Move group to folder](https://api.zenedu.io/api-reference/folders/move-group.md): Moves a group into a folder
- [Update product slugs](https://api.zenedu.io/api-reference/slugs/update-product.md): Updates public link slugs of a product
- [Update funnel slugs](https://api.zenedu.io/api-reference/slugs/update-funnel.md): Updates public link slugs of a funnel
- [Update offer slugs](https://api.zenedu.io/api-reference/slugs/update-offer.md): Updates public link slugs of a offer
- [Update funnel link slugs](https://api.zenedu.io/api-reference/slugs/update-funnel-link.md): Updates public link slugs of a funnel link
- [List webhooks](https://api.zenedu.io/api-reference/webhooks/list.md): Returns all webhook subscriptions for the authenticated account
- [Get webhook](https://api.zenedu.io/api-reference/webhooks/get.md): Returns a single webhook subscription by ID
- [List webhook events](https://api.zenedu.io/api-reference/webhooks/events.md): Returns the event types available for webhook subscriptions
- [Create webhook](https://api.zenedu.io/api-reference/webhooks/create.md): Creates a webhook subscription for the account
- [Send test webhook](https://api.zenedu.io/api-reference/webhooks/test.md): Queues a test delivery to the subscription's URL
- [Update webhook](https://api.zenedu.io/api-reference/webhooks/update.md): Updates a webhook subscription
- [Activate webhook](https://api.zenedu.io/api-reference/webhooks/activate.md): Activates a webhook subscription and clears any system stop
- [Deactivate webhook](https://api.zenedu.io/api-reference/webhooks/deactivate.md): Stops a webhook subscription without deleting it
- [Delete webhook](https://api.zenedu.io/api-reference/webhooks/delete.md): Deletes a webhook subscription
- [Create Zapier webhook](https://api.zenedu.io/api-reference/zapier/create-webhook.md): Registers a Zapier webhook for the specified bot (Pro)
- [Delete Zapier webhook](https://api.zenedu.io/api-reference/zapier/delete-webhook.md): Removes a Zapier webhook from the specified bot (Pro)
- [List Telegram files](https://api.zenedu.io/api-reference/telegram-files/list.md): Returns uploaded files not yet attached
- [Register or request a file](https://api.zenedu.io/api-reference/telegram-files/register.md): Register a file_id or ask the user to send a file to the bot
- [Delete Telegram file](https://api.zenedu.io/api-reference/telegram-files/delete.md): Deletes an unattached Telegram file
- [Download file](https://api.zenedu.io/api-reference/files/download.md): Downloads a file attached to a message

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.