Skip to main content

Create Loyalty Level

API operation: Open the endpoint in Scalar

Use POST /loyalty_levels to create a loyalty level. The operation documented here is LoyaltyLevel.register.

The documented schema requires administrator authentication and currently requires name, minimum_points, and accumulation_rate. Benefits, maximum accumulation settings, expiration, description, and image are operation-specific; confirm which optional settings your project supports.

See Loyalty levels model for the resource concepts.

OpenAPI reference​

Operation: POST /loyalty_levels

Request body fields

NameTypeRequired
accumulation_ratenumberYes
benefitsarray<any>No
descriptionanyNo
expire_after_minutesinteger | nullNo
imagesanyNo
maximum_accumulation_fixedinteger | nullNo
maximum_accumulation_percentageinteger | nullNo
minimum_pointsintegerYes
nameanyYes

Responses

CodeDescription
200OK
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference