Skip to main content
POST
/
generateLink
Generate Link API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/generateLink \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "xoxo_link.mutation.generateLink",
  "tag": "xoxo_link",
  "variables": {
    "data": {
      "campaignId": 123,
      "links_quantity": 1,
      "link_expiry": "19-03-1999"
    }
  }
}
'
{
  "data": {
    "generateLink": {
      "success": 1,
      "message": "Links generated successfully",
      "links": [
        "https://plum.xoxoday.com/claim/abc123",
        "https://plum.xoxoday.com/claim/def456"
      ],
      "batchId": "batch_20260415_001",
      "campaignName": "Summer Rewards",
      "campaignId": "123",
      "denomination_value": 10,
      "countryName": "USA",
      "currencyCode": "USD"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:xoxo_link.mutation.generateLink
required

Always use xoxo_link.mutation.generateLink.

Available options:
xoxo_link.mutation.generateLink
​
tag
enum<string>
default:xoxo_link
required

Always use xoxo_link.

Available options:
xoxo_link
​
variables
object
required

Response

Links generated successfully.

​
data
object