PUT/api/v2/loyalty/programs

Update loyalty program for the authenticated company

Authentication

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

Request body

application/json

Request body fields
FieldTypeRequiredDescription
NamestringYes
DescriptionstringNo
IsActivebooleanNo
PointValueRateunknownYes
PointValueCurrencystringNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
NamestringNo
DescriptionstringNo
IsActivebooleanNo
PointValueRateunknownNo
PointValueCurrencystringNo
Rulesarray of LoyaltyRuleResponseNo
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/programs" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Name":"…","PointValueRate":"…"}'

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