HEhel
Paylink

Update a Pay Link

Changed on

Update the details of a paylink.

patch/v1/paylink/{id}/api-key

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/paylink/{id}/api-key
  • Auth
    HTTP bearer

Path parameters

idstring required

The unique ID of the pay link you want to update.

Query parameters

apiKeystring required

Your API key can be generated from the Helio Dashboard settings.

Request body

namestring

Name or title of the pay link product or service.

pricestring

Price is an int64 represented in base units of the currency, e.g. "1000000" = 1 USDC.

pricingCurrencystring

Currency ID used to price the paylink (fiat or crypto). Retrieve this value from the Get Currencies endpoint.

limitSaleType'transaction' | 'discordId'

Restricts sales to a transaction count or specific Discord ID.

minQuantitynumber

Minimum quantity a user must purchase.

maxQuantitynumber

Maximum quantity a user can purchase.

raffleDetailsRaffleDetailsDto
redirectUrlstring

URL to redirect users after completing the payment.

redirectTimeout0 | 3

Delay (in seconds) before redirecting the user to redirectUrl after a successful payment. Use 0 for an instant redirect, or 3 to show the confirmation screen for 3 seconds before redirecting.

creationSource'PRIVATE_API' | 'PUBLIC_API'

Indicates whether the pay link was created via private or public API.

descriptionstring

Description of the product or service offered.

notifySenderByEmailboolean

If true, notifies the sender via email after a successful payment.

notifyReceiverByEmailboolean

If true, notifies the receiver via email after a successful payment.

addDiscordRoleboolean

Automatically assigns a Discord role upon successful payment.

discordRoleIdsstring[]

List of Discord role IDs to be assigned.

disabledboolean

If true, disables the pay link without deleting it.

dynamicboolean

Enables dynamic pricing features for the pay link.

maxTransactionsnumber

Maximum number of transactions allowed for this pay link.

nftCollectionAddressstring

Blockchain address of the NFT collection used in this pay link.

themeIdstring

Optional ID of a saved theme to apply to this paylink. A saved theme carries full light and dark palettes plus design tokens and is the recommended way to style hosted pages. Takes precedence over the dashboard default theme. For a one-off inline color scheme, use customTheme.

Response

Paylink successfully updated.

Changes