Skip to main content
POST
/
campaignDetails
cURL
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api \
  --header 'accept: application/json' \
  --header 'authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'content-type: application/json' \
  --data '{
    "query": "xoxo_link.mutation.campaignDetails",
    "tag": "xoxo_link",
    "variables": {
      "data": {
        "campaignId": 123
      }
    }
  }'
{
  "data": {
    "campaignDetails": {
      "success": 1,
      "data": [
        {
          "campaignId": 123,
          "campaignName": "Summer Rewards",
          "denomination_value": 10,
          "currency_code": "USD",
          "countryName": "USA",
          "vouchers": [
            {
              "name": "Amazon Gift Card",
              "image": "https://cdn.xoxoday.com/amazon.png"
            },
            {
              "name": "Starbucks Gift Card",
              "image": "https://cdn.xoxoday.com/starbucks.png"
            }
          ]
        }
      ]
    }
  }
}

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.

​
Get Campaign Details Schema

PropertyTypeDescription
campaignIdIntUnique identifier of the campaign to fetch.

​
Response Schema

PropertyTypeDescription
dataobjectRoot response object.
data.campaignDetailsobjectContainer for campaign details.
data.campaignDetails.successnumberAPI execution status (1 = success).
data.campaignDetails.dataarrayList containing campaign detail entries.
data.campaignDetails.data[].campaignIdnumberUnique campaign ID.
data.campaignDetails.data[].campaignNamestringName of the campaign.
data.campaignDetails.data[].denomination_valuenumberDenomination/value associated with the campaign.
data.campaignDetails.data[].currency_codestringCurrency code for denomination.
data.campaignDetails.data[].countryNamestringApplicable country for the campaign.
data.campaignDetails.data[].vouchersarrayList of vouchers/products associated with this campaign.
data.campaignDetails.data[].vouchers[].namestringVoucher/product name.
data.campaignDetails.data[].vouchers[].imagestringImage URL for the voucher/product.

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

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

Always use xoxo_link.mutation.campaignDetails.

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

Always use xoxo_link.

Available options:
xoxo_link
​
variables
object
required

Response

Campaign details returned successfully.

​
data
object