PUT/api/v2/loyalty/merchants/{merchantId}/loyalty-rules/{ruleId}

Update an existing merchant loyalty rule

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
merchantId (path)unknownYesThe unique identifier of the merchant
ruleId (path)unknownYesThe unique identifier of the merchant loyalty rule

Request body

application/json

Request body fields
FieldTypeRequiredDescription
RuleNamestringYes
PointsPerUnitunknownYes
MultiplierunknownNo
MinTransactionAmountunknownNo
MaxTransactionAmountunknownNo
IsActivebooleanNo
ValidFromstring (date-time)No
ValidUntilstring (date-time)No

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
RuleNamestringNo
PointsPerUnitunknownNo
MultiplierunknownNo
MinTransactionAmountunknownNo
MaxTransactionAmountunknownNo
IsActivebooleanNo
ValidFromstring (date-time)No
ValidUntilstring (date-time)No
CreatedAtstring (date-time)No
UpdatedAtstring (date-time)No

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X PUT "https://{base_url}/api/v2/loyalty/merchants/{merchantId}/loyalty-rules/{ruleId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"RuleName":"…","PointsPerUnit":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.