Unified Promotions is a flexible workflow that allows you to configure a single promotion for multiple reward outcomes. Instead of creating separate campaigns for different benefits, you can use one unified promotion to offer loyalty points, coupons, badges, rewards, or customer opt-ins.

Example request

curl --location 'https://eu.api.capillarytech.com/v3/unifiedPromotions' \
--header 'content-type: application/json' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86MmQ1OT1OGE2NWI5ZjAxMzU5NGIwNDllZTk=' \
--header 'Cookie: _cfuvid=BC9cwq9x9u_qIzIGlUxLEwV1ldTNVbpH1faK4-1763285329155-0.0.1.1-604800000' \
--data '{
  "metadata": {
    "name": "Daily Perks - Spend 50 Get 100 Points",
    "description": "Spend over $50 in a single transaction to get 100 bonus points. Limited to once per user per day.",
    "orgId": 100737,
    "programId": 973,
    "startDate": "2025-12-01T00:00:00+05:30",
    "endDate": "2025-12-31T23:59:59+05:30",
    "promotionType": "LOYALTY_EARNING",
    "status": "DRAFT",
    "timezoneName": "Asia/Kolkata",
    "promoIdentifer": "DAILY_PERKS_DEC25",
    "loyaltyConfigMetaData": {
      "isStackable": false,
      "isExclusive": false,
      "isAlwaysApply": false,
      "isConsideredForRanking": false
    },
    "loyaltyEarningType": "DIRECT_EARN",
    "promotionMetadata": []
  },
  "customerEnrolment": {
    "enrolmentMethod": "TRANSACTION",
    "audienceGroups": []
    "audienceGroups": [],
    "customerEligibilityType": "ALL"
  },
  "activities": [
    {
      "id": "activity_1763300000001",
      "type": "SINGLE",
      "name": "Spend Over $50",
      "event": "TransactionAdd",
      "expJSON": "{\n  \"arity\": \"binary_operation\",\n  \"type\": \"boolean:primitive\",\n  \"value\": \">\",\n  \"operands\": [\n    {\n      \"arity\": \"object_dereference\",\n      \"type\": \"real:object:primitive\",\n      \"operands\": [\n        {\n          \"arity\": \"name\",\n          \"type\": \"transaction:object:primitive\",\n          \"value\": \"currentTransaction\"\n        },\n        {\n          \"arity\": \"name\",\n          \"type\": \"real:object:primitive\",\n          \"value\": \"amount\"\n        }\n      ]\n    },\n    {\n      \"arity\": \"literal\",\n      \"type\": \"number:primitive\",\n      \"value\": \"50\"\n    }\n  ]\n}",
      "commonCycleActionMapping": [
        {
          "cycle": "Cycle_1",
          "startDate": "2025-12-01",
          "endDate": "2025-12-31",
          "actions": [
            {
              "id": "temp_action_award_points",
              "actionName": "AWARD_POINTS_ACTION",
              "actionClass": "com.capillary.shopbook.pointsengine.endpoint.impl.action.AwardPointsActionImpl",
              "description": "Award 100 Bonus Points",
              "mandatoryPropertiesValues": {
                "AwardStrategy": "109010",
                "ExpiryStrategy": "109006",
                "PointType": "Points"
              },
              "mandatoryComplexPropertiesValues": {},
              "embeddedStrategies": []
            }
          ]
        }
      ],
      "milestones": []
    }
  ],
  "limits": [
    {
      "granularity": "USER",
      "actionType": "AWARD_CURRENCY",
      "actionSubTypeId": "Points",
      "limitType": "COUNT",
      "limitValue": 1,
      "period": {
        "periodType": "MOVING_WINDOW",
        "periodUnit": "DAYS",
        "periodValue": 1
      }
    }
  ],
  "liabilityOwnerSplitInfo": [
    {
      "liabilityOwnerId": 82,
      "componentType": "PROMOTION",
      "ratio": 100,
      "isActive": true,
      "liabilityOwnerName": "DocDemoDefaultProgram",
      "liabilityOwnerType": "PROGRAM",
      "orgId": 100737
    }
  ],
  "workflowMetadata": {
    "optin": {},
    "enrolment": {}
  }
}'

Prerequisites

Authentication: Basic or OAuth authentication.
Default access group

▶Body Parameters

▶metadata object table

▶Customer enrollment and workflows object table

▶The activities Object

▶limits Object

▶liabilityOwnerSplitInfo Object

▶Example response

▶Response body parameters

▶Error codes