peyk.platforms.telegram.methods.upgrade_gift

async peyk.platforms.telegram.methods.upgrade_gift(self, business_connection_id: str, owned_gift_id: str, *, keep_original_details: bool | None = None, star_count: int | None = None) → bool

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.

Parameters:

  • business_connection_id – Unique identifier of the business connection

  • owned_gift_id – Unique identifier of the regular gift that should be upgraded to a unique one

  • keep_original_details – Pass True to keep the original gift text, sender and receiver in the upgraded gift

  • star_count – The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.

Returns:

Result returned by Telegram on successful execution.

Return type:

bool