v4
OpenAPI 3.0.02026-07-31811,0021.1 MBChange the tier of a customer in BonifiQ
This endpoint allows you to manually change the tier of a customer. The tier affects how the customer accrues points and which rewards are available to them.
Some important remarks
- The TierId field is required and must match an existing tier configured in BonifiQ. If the tier does not exist, the API returns an error with the Tier_NotFound error code.
- If the customer already belongs to a tier, they will be removed from the old tier and assigned to the new one.
- If the customer does not exist, the API returns an error with the Customer_NotFound error code.
- This endpoint does not calculate tiers automatically based on points or history. It is a manual override.
The GracePeriodInDays field
This optional field allows you to define a grace period (in days) for the tier change. This can be useful when promoting a customer temporarily or when a business rule requires the customer to stay in the tier for a limited time.
The GracePeriodComments field
This optional field allows you to add a comment explaining the reason for the grace period. This information is internal-use only and will not be visible to the customer.
Response
On success, the response contains the CustomerId, the new TierId, the CurrentTierName, and the OldTierName (if the customer was previously in a tier).
Path parameters
Id from the client's store, usually email address or document
Request body
Response
The updated tier information including old and new tier names, or an error response