Upsert offer - Lobyco Help center

curl --request POST \
  --url https://{host}/promotion/v2/campaigns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "unifiedCampaignId": "",
  "campaignId": "ce57fcd0-c345-48f7-911f-2cbde7d25a0c",
  "campaignName": "coca_cola_10p_off",
  "validFrom": "2026-08-09T00:00:00Z",
  "validTo": "2026-08-15T00:00:00Z",
  "previewVisibleFrom": null,
  "campaignType": "appCoupon",
  "content": null,
  "prices": {
    "currency": "EUR",
    "normalPrice": 5,
    "price": null,
    "normalPricePerUnit": 10,
    "pricePerUnit": null
  },
  "discount": {
    "priority": 5,
    "allowOtherDiscountsOnTop": false,
    "applyOnHighestPrice": null,
    "itemsApplicationType": "NonDiscountedItems",
    "impactLevel": "Line",
    "discountType": null,
    "maxDiscountAmount": 5,
    "maxDiscountAmountPerCoupon": null,
    "maxNumberApplyPerReceipt": 1,
    "applicationType": "OnThreshold",
    "checkoutTypes": null,
    "rewardRedemptionSettings": null,
    "rules": [
      {
        "type": "Percentage",
        "value": 0.1,
        "thresholdType": "Quantity",
        "thresholdValue": 1,
        "affiliations": [
          {
            "type": "Product",
            "id": "coca-cola",
            "applicationType": "Include"
          },
          {
            "type": "Product",
            "id": "fanta",
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "redemptionLimit": 1,
  "totalCoupons": null,
  "isDefault": false,
  "chainIds": [
    "1"
  ],
  "storeIds": [],
  "offerSynchronized": null,
  "fundedBy": "",
  "audience": null,
  "isTemplate": false,
  "displayPriority": null,
  "preactivated": null,
  "ignoreOnPos": null,
  "published": null,
  "defaultValidForDays": null,
  "metadata": null
}
'

{
  "campaignId": "<string>",
  "campaignName": "<string>",
  "unifiedCampaignId": "<string>",
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "previewVisibleFrom": "2023-11-07T05:31:56Z",
  "campaignType": "<string>",
  "content": {
    "iconTags": [
      {
        "name": "<string>",
        "iconUrl": "<string>"
      }
    ],
    "title": "<string>",
    "description": "<string>",
    "brand": "<string>",
    "imageUrl": "<string>",
    "discountLabel": "<string>",
    "normalPriceLabel": "<string>",
    "pricePerUnitLabelEnabled": true,
    "unitOfMeasure": "<string>",
    "conditionLabel": "<string>",
    "receiptDisplayText": "<string>",
    "tags": [
      "<string>"
    ],
    "icons": [
      "<string>"
    ],
    "autogenerateDiscountLabel": true
  },
  "prices": {
    "currency": "<string>",
    "normalPrice": 50000000,
    "price": 123,
    "normalPricePerUnit": 50000000,
    "pricePerUnit": 123
  },
  "discount": {
    "priority": 123,
    "allowOtherDiscountsOnTop": true,
    "itemsApplicationType": "AllItems",
    "impactLevel": "Line",
    "maxDiscountAmount": 123,
    "maxDiscountAmountPerCoupon": 123,
    "maxNumberApplyPerReceipt": 123,
    "maxNumberApplyPerReceiptDecimal": 123,
    "applyOnHighestPrice": true,
    "applicationType": "OnThreshold",
    "discountType": "Unknown",
    "checkoutTypes": [
      "<string>"
    ],
    "rewardRedemptionSettings": {
      "redeemableFrom": "2023-11-07T05:31:56Z",
      "redeemableTo": "2023-11-07T05:31:56Z",
      "redeemableForDays": 123
    },
    "rules": [
      {
        "type": "FixedPrice",
        "value": 50000000,
        "thresholdType": "Quantity",
        "thresholdValue": 50000000,
        "affiliations": [
          {
            "type": "Product",
            "id": "<string>",
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "status": "Imported",
  "redemptionLimit": 123,
  "totalCoupons": 123,
  "statistics": {
    "assignedCoupons": 123,
    "activatedCoupons": 123,
    "claimedCoupons": 123,
    "totalValue": 123,
    "minValue": 123,
    "maxValue": 123,
    "avgValue": 123,
    "minBasket": 123,
    "maxBasket": 123,
    "avgBasket": 123
  },
  "chainIds": [
    "<string>"
  ],
  "storeIds": [
    "<string>"
  ],
  "isDefault": true,
  "offerSynchronized": true,
  "fundedBy": "<string>",
  "audience": {
    "audienceId": "<string>"
  },
  "metadata": {},
  "authorName": "<string>",
  "isTemplate": true,
  "displayPriority": 123,
  "preactivated": true,
  "ignoreOnPos": true,
  "defaultValidForDays": 123,
  "rewardRedemptionSettings": {
    "redeemableFrom": "2023-11-07T05:31:56Z",
    "redeemableTo": "2023-11-07T05:31:56Z",
    "redeemableForDays": 123
  },
  "modifiedDate": "2023-11-07T05:31:56Z",
  "modifiedBy": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

POST

campaigns

curl --request POST \
  --url https://{host}/promotion/v2/campaigns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "unifiedCampaignId": "",
  "campaignId": "ce57fcd0-c345-48f7-911f-2cbde7d25a0c",
  "campaignName": "coca_cola_10p_off",
  "validFrom": "2026-08-09T00:00:00Z",
  "validTo": "2026-08-15T00:00:00Z",
  "previewVisibleFrom": null,
  "campaignType": "appCoupon",
  "content": null,
  "prices": {
    "currency": "EUR",
    "normalPrice": 5,
    "price": null,
    "normalPricePerUnit": 10,
    "pricePerUnit": null
  },
  "discount": {
    "priority": 5,
    "allowOtherDiscountsOnTop": false,
    "applyOnHighestPrice": null,
    "itemsApplicationType": "NonDiscountedItems",
    "impactLevel": "Line",
    "discountType": null,
    "maxDiscountAmount": 5,
    "maxDiscountAmountPerCoupon": null,
    "maxNumberApplyPerReceipt": 1,
    "applicationType": "OnThreshold",
    "checkoutTypes": null,
    "rewardRedemptionSettings": null,
    "rules": [
      {
        "type": "Percentage",
        "value": 0.1,
        "thresholdType": "Quantity",
        "thresholdValue": 1,
        "affiliations": [
          {
            "type": "Product",
            "id": "coca-cola",
            "applicationType": "Include"
          },
          {
            "type": "Product",
            "id": "fanta",
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "redemptionLimit": 1,
  "totalCoupons": null,
  "isDefault": false,
  "chainIds": [
    "1"
  ],
  "storeIds": [],
  "offerSynchronized": null,
  "fundedBy": "",
  "audience": null,
  "isTemplate": false,
  "displayPriority": null,
  "preactivated": null,
  "ignoreOnPos": null,
  "published": null,
  "defaultValidForDays": null,
  "metadata": null
}
'

{
  "campaignId": "<string>",
  "campaignName": "<string>",
  "unifiedCampaignId": "<string>",
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "previewVisibleFrom": "2023-11-07T05:31:56Z",
  "campaignType": "<string>",
  "content": {
    "iconTags": [
      {
        "name": "<string>",
        "iconUrl": "<string>"
      }
    ],
    "title": "<string>",
    "description": "<string>",
    "brand": "<string>",
    "imageUrl": "<string>",
    "discountLabel": "<string>",
    "normalPriceLabel": "<string>",
    "pricePerUnitLabelEnabled": true,
    "unitOfMeasure": "<string>",
    "conditionLabel": "<string>",
    "receiptDisplayText": "<string>",
    "tags": [
      "<string>"
    ],
    "icons": [
      "<string>"
    ],
    "autogenerateDiscountLabel": true
  },
  "prices": {
    "currency": "<string>",
    "normalPrice": 50000000,
    "price": 123,
    "normalPricePerUnit": 50000000,
    "pricePerUnit": 123
  },
  "discount": {
    "priority": 123,
    "allowOtherDiscountsOnTop": true,
    "itemsApplicationType": "AllItems",
    "impactLevel": "Line",
    "maxDiscountAmount": 123,
    "maxDiscountAmountPerCoupon": 123,
    "maxNumberApplyPerReceipt": 123,
    "maxNumberApplyPerReceiptDecimal": 123,
    "applyOnHighestPrice": true,
    "applicationType": "OnThreshold",
    "discountType": "Unknown",
    "checkoutTypes": [
      "<string>"
    ],
    "rewardRedemptionSettings": {
      "redeemableFrom": "2023-11-07T05:31:56Z",
      "redeemableTo": "2023-11-07T05:31:56Z",
      "redeemableForDays": 123
    },
    "rules": [
      {
        "type": "FixedPrice",
        "value": 50000000,
        "thresholdType": "Quantity",
        "thresholdValue": 50000000,
        "affiliations": [
          {
            "type": "Product",
            "id": "<string>",
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "status": "Imported",
  "redemptionLimit": 123,
  "totalCoupons": 123,
  "statistics": {
    "assignedCoupons": 123,
    "activatedCoupons": 123,
    "claimedCoupons": 123,
    "totalValue": 123,
    "minValue": 123,
    "maxValue": 123,
    "avgValue": 123,
    "minBasket": 123,
    "maxBasket": 123,
    "avgBasket": 123
  },
  "chainIds": [
    "<string>"
  ],
  "storeIds": [
    "<string>"
  ],
  "isDefault": true,
  "offerSynchronized": true,
  "fundedBy": "<string>",
  "audience": {
    "audienceId": "<string>"
  },
  "metadata": {},
  "authorName": "<string>",
  "isTemplate": true,
  "displayPriority": 123,
  "preactivated": true,
  "ignoreOnPos": true,
  "defaultValidForDays": 123,
  "rewardRedemptionSettings": {
    "redeemableFrom": "2023-11-07T05:31:56Z",
    "redeemableTo": "2023-11-07T05:31:56Z",
    "redeemableForDays": 123
  },
  "modifiedDate": "2023-11-07T05:31:56Z",
  "modifiedBy": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The offer to create or update.

unifiedCampaignId

string | null

ID of Unified Campaign.

Maximum string length: 64

campaignId

string | null

ID of Promotion Campaign.

Maximum string length: 255

campaignName

string | null

Name of the campaign visible in the admin tools.

Maximum string length: 255

validFrom

string<date-time> | null

Date when any coupons for this promotion campaign become available to pick up in store.

validTo

string<date-time> | null

Date when all coupons for this promotion campaign stop being available to pick up in the store.

previewVisibleFrom

string<date-time> | null

Date when Coupons will be returned in API and visible in the app. Cannot be cleared after being set.

campaignType

string | null

Customer specific campaign type. Determines how or by which service campaign will be used. Types used so far: game, appCoupon, gift, preferredStore, memberOffer, stampCard, stickersCampaign, segmentedAppCoupon. If not specified during creation, default type will be used.

Maximum string length: 255

content

object

Show child attributes

prices

object

Show child attributes

discount

object

Show child attributes

redemptionLimit

integer<int32> | null

Specifies how many times coupon can be redeemed in store. Each redemption is a separate purchase. Amount of time a coupon can be used in one purchase is controlled by Discount model. When not specified, defaults to last stored value on update, or 1 on create. Use 0 to indicate that coupon can be redeemed unlimtied amount of times. If value is not equal to 1, we recommned providing Idempotency key during redemption, or weird behavior might happen.

totalCoupons

integer<int32> | null

Total amount of possible coupons in the campaign. When it is null, unlimited amount of coupons can be assigned.

isDefault

boolean | null

Can be true only for personal campaigns ("personalOffer", "relevantOffer"). When true, this campaign will be returned for a user that has no coupons assigned in personal campaigns.

chainIds

string[] | null

List of Chain Ids where Promotion campaign is available. Mutually exclusive with StoreIds.

storeIds

string[] | null

List of Store Ids where Promotion campaign is available. Mutually exclusive with ChainIds.

offerSynchronized

boolean | null

Specifies if offer was successfully synchronized into customer system

fundedBy

string | null

Specifies who this offer is funded by. Retailers can use any values they need, or keep it empty

Maximum string length: 100

audience

object

Show child attributes

isTemplate

boolean | null

Specifies if the offer is template, meaning it can be used as a base for other offers during creation

displayPriority

integer<int32> | null

Controlls the order in which coupons are returned to the mobile app. Lower number means higher priority

preactivated

boolean | null

Specifies if coupons for this offer require activation, or are working on POS without activation

ignoreOnPos

boolean | null

Specifies if coupons should be visible and processed by POS.

published

boolean | null

When set to true, offer will be also published during upsert. When set to false, Offer will be moved to draft. When not specified, offer status will not be checked.

defaultValidForDays

integer<int32> | null

Default number of days a Triggered coupon is valid for, when no explicit value is specified during assignment

metadata

object | null

Allows to store any arbitrary data in Campaign, returned in all get requests and sent to IL during activation. Can be null.

Show child attributes

Response

campaignId

string

required

ID of Promotion Campaign.

Required string length: 1 - 255

campaignName

string

required

Name of the campaign visible in the admin tools.

Required string length: 1 - 255

unifiedCampaignId

string | null

ID of Turboflow Campaign.

Maximum string length: 64

validFrom

string<date-time> | null

Date when any coupons for this promotion campaign become available to pick up in store.

validTo

string<date-time> | null

Date when all coupons for this promotion campaign stop being available to pick up in the store.

previewVisibleFrom

string<date-time> | null

Date when Coupons will be returned in API and visible in the app. Optional. When not specified, ValidFrom is used.

campaignType

string | null

Maximum string length: 255

content

object

Show child attributes

prices

object

Show child attributes

discount

object

Show child attributes

status

enum<string>

Available options:

Imported,

Active,

Expired,

Scheduled

redemptionLimit

integer<int32>

Specifies how many times coupon can be redeemed in store. Each redemption is a separate purchase. Amount of time a coupon can be used in one purchase is controlled by Discount model.

totalCoupons

integer<int32> | null

Total amount of possible coupons in the campaign. When it is null, unlimited amount of coupons can be assigned.

statistics

object

Statistical data about campaign. Can be null if not requested.

Show child attributes

chainIds

string[] | null

List of Chain Ids where Promotion campaign is available. Mutually exclusive with StoreIds. Can be null if not requested

storeIds

string[] | null

List of Store Ids where Promotion campaign is available. Mutually exclusive with ChainIds. Can be null if not requested

isDefault

boolean | null

Can be true only for personal campaigns ("personalOffer", "relevantOffer"). When true, this campaign will be returned for a user that has no coupons assigned in personal campaigns.

offerSynchronized

boolean

Specifies if offer was successfully synchronized into customer system

fundedBy

string | null

Specifies who this offer is funded by. Retailers can use any values they need, or keep it empty

Maximum string length: 100

audience

object

Show child attributes

metadata

object | null

Allows to store any arbitrary data in Campaign, returned in all get requests and sent to IL during activation. Can be null.

Show child attributes

authorName

string | null

The name of the person/entity that created the offer."

Maximum string length: 64

isTemplate

boolean

Specifies if the offer is template, meaning it can be used as a base for other offers during creation

displayPriority

integer<int32>

Controlls the order in which coupons are returned to the mobile app. Lower number means higher priority

preactivated

boolean

Specifies if coupons for this offer require activation, or are working on POS without activation

ignoreOnPos

boolean

Specifies if coupons should be visible and processed by POS.

defaultValidForDays

integer<int32> | null

Default number of days a Triggered coupon is valid for, when no explicit value is specified during assignment

rewardRedemptionSettings

object

Settings related to the redemption of a reward granted by an offer. Applicable only for Bonus type offers.

Show child attributes

modifiedDate

string<date-time> | null

The date and time when the campaign was modified. Changes every time the campaign is updated.

modifiedBy

string | null

The name of the person/entity that last updated the offer.

Maximum string length: 64

Last modified on August 10, 2026

⌘I