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

parameter	type	required	description
`business_connection_id`	string	required	Unique identifier of the business connection
`owned_gift_id`	string	required	Unique identifier of the regular gift that should be transferred
`new_owner_chat_id`	number	required	Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
`star_count`	number	optional	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

boolean

usage in yaebal

transferGift is directly typed on Api — call it straight off bot.api.

bot.ts

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

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

context shortcut

also available as ctx.transferGift() on 4 context types — see @yaebal/contexts.

context shortcut

/** 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. */
ctx.transferGift(params: Omit<TransferGiftParams, "business_connection_id"> & { business_connection_id?: string })

official Bot API docs: https://core.telegram.org/bots/api/#transfergift