Create Campaign

Campaigns are the core of your loyalty program. See the sample example of how this can be configured. Links to more detailed instructions can be found at the end of the article.

How this example works

OpenLoyalty allows you to create various types of campaigns to engage and reward your customers. You can set up point-based campaigns, referral campaigns, or even time-based promotions.

Creating campaigns is a complex process, but using the admin panel can simplify it.

In this example, we will create a campaign that rewards a member with 100 points for each transaction.

---

Try yourself

• Input the previous saved token and storeCode in the request header

• Create a campaign Endpoint: POST /api/{storeCode}/campaign

  {
      "campaign": {
          "type": "direct",
          "trigger": "transaction",
          "translations": {
              "en": {
                  "name": "Get 100 points for any transaction",
                  "description": ""
              }
          },
          "activity": {
              "startsAt": "2024-01-01 00:00+00:00",
              "endsAt": null
          },
          "rules": [
              {
                  "effects": [
                      {
                          "effect": "give_points",
                          "pointsRule": "100",
                          "walletCode": "default"
                      }
                  ]
              }
          ],
          "labels": [],
          "limits": {},
          "active": true
      }
  }

---

Endpoints used

Create a new campaign

post

This method allows creating a new Campaign.

Authorizations

Path parameters

storeCodestringrequired

Store code

Body

one ofoptional

When campaign is referral type, you can specified multi level

Campaign triggered by a unique code from custom event

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://openloyalty.localhost/api/{storeCode}/campaign' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "campaign": {
      "translations": {
        "en": {
          "name": "text",
          "description": "text"
        },
        "pl": {
          "name": "text",
          "description": "text"
        }
      },
      "displayOrder": 1,
      "type": "direct",
      "trigger": "transaction",
      "triggerStrategy": {
        "type": "daily"
      },
      "activity": {
        "startsAt": "2025-03-27T17:34:29.517Z",
        "endsAt": "2025-03-27T17:34:29.517Z"
      },
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "visibility": {
        "target": "segment"
      },
      "audience": {
        "target": "segment"
      },
      "active": true,
      "rules": [
        {
          "name": "text",
          "description": "text",
          "effects": [
            {
              "effect": "give_points",
              "data": {}
            }
          ],
          "conditions": [
            {
              "attribute": "text",
              "operator": "expression"
            }
          ]
        }
      ],
      "limits": {
        "points": {
          "interval": {
            "type": "days",
            "value": 1
          },
          "value": 1
        },
        "pointsPerMember": {
          "interval": {
            "type": "days",
            "value": 1
          },
          "value": 1
        },
        "executionsPerMember": {
          "interval": {
            "type": "days",
            "value": 1
          },
          "value": 1
        }
      }
    }
  }'

200

400

401

403

404

200

{
  "campaignId": "00000000-0000-0000-0000-000000000000"
}

Return created campaign ID.

---

More resources

For a detailed overview and description of the campaign creation and management, please refer to these series of articles:

CampaignsUser Guide