Available methods

transferGift()

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

parametertyperequireddescription
business_connection_idstringrequiredUnique identifier of the business connection
owned_gift_idstringrequiredUnique identifier of the regular gift that should be transferred
new_owner_chat_idnumberrequiredUnique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
star_countnumberoptionalThe 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

boolean

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { TransferGiftParams } from "@yaebal/types";

await bot.api.call<boolean>("transferGift", {
  business_connection_id: "...",
  owned_gift_id: "...",
  new_owner_chat_id: 1,
} satisfies TransferGiftParams);