Send Your First Reward Link

Once you’ve created a campaign in the Plum Admin Dashboard, follow the steps below to send a Reward Link using APIs:

Get Campaign ID
First, fetch the list of campaigns from your Plum dashboard to get the campaignId of the campaign you want to use.

Request

curl --location 'https://canvas.xoxoday.com/chef/v1/oauth/api' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'content-type: application/json' 
--header 'Authorization: ••••••' \
--data '{
  "tag":"xoxo_link",
  "query":"xoxo_link.query.campaignList",
  "variables" : { "add_data": { "limit": 10, "offset": 0, "name": "", "enabled" : 1} }

}'

Response

{
    "data": {
        "campaignList": {
            "success": 1,
            "data": [
                {
                    "campaignId": 2461,
                    "campaignName": "Test Campaign",
                    "denomination_value": 10,
                    "countryName": "USA",
                    "currencyCode": "USD",
                    "created_date": "0000-00-00 00:00:00",
                    "product_count": "1",
                    "status": 1
                }
            ],
            "count": 1,
            "errors": null
        }
    }
}

Send Reward Link
Now use the retrieved campaignId to send a Reward Link to a recipient.

Request

curl --location 'https://canvas.xoxoday.com/chef/v1/oauth/api/sendLinks' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'content-type: application/json' 
--header 'Authorization: ••••••' \
--data-raw '{
    "query": "xoxo_link.mutation.generateLinkEmail",
    "tag": "xoxo_link",
    "variables": {
        "data": {
            "campaignId": "2455",
            "email_ids": "[email protected]",
            "link_expiry": "31-07-2026"
        }
    }
}'

Response

{
    "data": {
        "generateLink": {
            "success": 1,
            "message": "Links created successfully"
        }
    }
}

Reward Link Delivery
Once the request is successful, the recipient will receive an email with their Reward Link.

That’s it! You’ve successfully created and sent a Reward Link via the Reward Link APIs.