Skip to main content

Customer Offer Update

This endpoints allow to set or remove customer like.

Request​

PATCH <API base url>/customers/{customerId}/offers/{offerId}

Body​

{
  "activationStatus": optional string (one of - undefined, activated, viewed),
  "isFavorite": optional bool,
  "isLiked": optional bool,
  "certificateExpiresAt": optional date
}

Response​

On success:

{
  "value": required {
    "activationStatus": required string (one of - undefined, activated, viewed),
    "isFavorite": required  bool,
    "isLiked": required bool,
    "likesCount": optional number,
    "accruedReward" : optional {
      "id": required uint64,
      "createdAt": required date,
      "promoCode": optional {
        "value": optional string,
        "status": required string (one of - unassigned, displayed),
        // recommended display type is a first element in displayTypes
        "displayTypes": required string[] (plainText, qr, barcodeCode128, barcodeEan13)
      },
      "certificate": optional {
        "provider": required string,
        "ids": optional string[],
        "value": optional number
      },
      "expiresAt": optional date,
      "isSpent": required boolean,
      "isOpened": required boolean,
      "customData": optional any
    }
  }
}