peyk.platforms.telegram.methods.transfer_gift¶
- async peyk.platforms.telegram.methods.transfer_gift(self, business_connection_id: str, owned_gift_id: str, new_owner_chat_id: int, *, star_count: int | None = None) bool¶
Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer 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 transferred
new_owner_chat_id – Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
star_count – The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.
- Returns:
Result returned by Telegram on successful execution.
- Return type:
bool