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

Bearer

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

Body

application/json

or

or

Responses

200

Return created campaign ID.

application/json

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post

/api/{storeCode}/campaign

HTTPcURLJavaScriptPython

POST /api/{storeCode}/campaign HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 776

{
  "campaign": {
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      },
      "pl": {
        "name": "text",
        "description": "text"
      }
    },
    "displayOrder": 1,
    "type": "direct",
    "trigger": "transaction",
    "triggerStrategy": {
      "type": "daily"
    },
    "activity": {
      "startsAt": "2026-02-16T15:58:44.561Z",
      "endsAt": "2026-02-16T15:58:44.561Z"
    },
    "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
      }
    }
  }
}

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

---

More resources

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

Campaigns