Skip to main content

bots.updateStarRefProgram

Create, edit or delete the affiliate program of a bot we own

func (c *Client) BotsUpdateStarRefProgram(ctx context.Context, request *BotsUpdateStarRefProgramRequest) (*StarRefProgram, error)

Calling this method​

client.Run(ctx, func(ctx context.Context) error {
	api := client.API()
	
	res, err := api.BotsUpdateStarRefProgram(ctx, &tg.BotsUpdateStarRefProgramRequest{
		// see Parameters
	})
	if err != nil {
		return err
	}
	_ = res // *StarRefProgram
	return nil
})

Parameters​

NameTypeRequiredDescription
BotInputUserClassyesThe bot
CommissionPermilleintyesThe permille commission rate: it indicates the share of Telegram Stars received by affiliates for every transaction made by users they referred inside of the bot. The minimum and maximum values for this parameter are contained in the starref_min_commission_permille and starref_max_commission_permille client configuration parameters. Can be 0 to terminate the affiliate program. Both the duration and the commission may only be raised after creation of the program: to lower them, the program must first be terminated and a new one created.
DurationMonthsint—Indicates the duration of the affiliate program; if not set, there is no expiration date.

Returns​

*StarRefProgram

Possible errors​

CodeTypeDescription
400BOT_INVALIDThis is not a valid bot.
400STARREF_AWAITING_ENDThe previous referral program was terminated less than 24 hours ago: further changes can be made after the date specified in userFull.starref_program.end_date.
400STARREF_PERMILLE_INVALIDThe specified commission_permille is invalid: the minimum and maximum values for this parameter are contained in the starref_min_commission_permille and starref_max_commission_permille client configuration parameters.
400STARREF_PERMILLE_TOO_LOWThe specified commission_permille is too low: the minimum and maximum values for this parameter are contained in the starref_min_commission_permille and starref_max_commission_permille client configuration parameters.

References​