Generate Link API

The Generate Link API allows you to generate links in bulk for reward distribution. The API is useful for reward automation without the recipient's email address.

Generate Link API Schema

PropertyTypeDescription
campaignIdStringUnique identifier of the campaign for which the link(s) should be generated.
links_quantityIntNumber of links to generate.
link_expiryStringExpiry date for the link(s) (format: DD-MM-YYYY).

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.generateLinkobjectContainer for link generation result.
data.generateLink.successnumberAPI execution status (1 = success).
data.generateLink.messagestringMessage returned by the API.
data.generateLink.linksarrayList of generated reward/claim links.
data.generateLink.links[]stringIndividual generated link URL.
data.generateLink.batchIdstringUnique batch identifier for the generated link set.
data.generateLink.campaignNamestringName of the campaign for which links were generated.
data.generateLink.campaignIdstringCampaign ID (string returned by API).
data.generateLink.denomination_valuenumberDenomination/value associated with the generated links.
data.generateLink.countryNamestringCountry for which the link campaign applies.
data.generateLink.currencyCodestringCurrency code for the denomination.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!