Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Update Loyalty Program Details

Update Program

Update the details of a specific loyalty program based on provided data.

  • programId: The unique identifier of the loyalty program.
  • data: A dictionary containing the fields to update.
  • Returns: The updated program details.
put/v2/loyalty/programs/{programId}

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Request body

namestring nullable
descriptionstring nullable
languagestring nullable
countrystring nullable
companystring nullable
addressstring nullable
websitestring uri nullable
phonestring nullable
termsstring nullable
pointsAddEmailinteger nullable
pointsAddPhoneinteger nullable
pointsInstallPassinteger nullable
pointsScanPassinteger nullable
dynamicScanPointsboolean nullable
pointsReferralinteger nullable
referralRequiredPointsinteger nullable
scannerType'Browser' | 'PassVerifier' | 'CodeReadr' | 'None'
customPointsChangeMessagestring nullable
disableCustomPointsChangeMessageboolean nullable
customPointNamestring nullable
customPointsNamestring nullable
requiredFieldsstring[]
retention_period_daysinteger nullable

Days to retain deleted data (0-365)

Response

Successful Response

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