Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Update Loyalty Program Offer

Update Offer

Updates an existing offer within a loyalty program.

  • Path Parameters:

    • programId: UUID of the loyalty program
    • offerId: UUID of the offer

  • Request Body:

    • data: JSON object containing offer data to be updated.

  • Returns:

    • Updated offer details as a JSON object.
put/v2/loyalty/programs/{programId}/offers/{offerId}

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593
string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Request body

namestring required
descriptionstring nullable
startDatestring date-time nullable
endDatestring date-time nullable
autoClaimboolean nullable
autoClaimOverwriteboolean nullable
notifyboolean nullable
notifyMessagestring nullable
pointsMininteger nullable
pointsMaxinteger nullable
pointsCostinteger nullable
limitPerCustomerinteger nullable
availabilityCountinteger nullable
valuenumber nullable
currencystring nullable
type'fixed' | 'percent' | 'other'
categoriesstring nullable
productsstring nullable
priceRule'min' | 'max' | 'none'

Response

Successful Response

{"stackTrail":"paths:/v2/loyalty/programs/{programId}/offers/{offerId}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}