v4

OpenAPI 3.0.02026-07-31811,0021.1 MB

Customer

Change the Status of the customer in BonifiQ

An active customer (IsEnabled=true) can receive points and participate in the program points. An inactive customer (IsEnabled=false) will not receive points nor will be able to redeem rewards.

The Reason field is required and will be used to track why the status has changed. This information is internal-use only, it will not be visible to the customer.

post/v1/pvt/Customer/{originalId}/changestatus

Path parameters

originalIdstring required

Request body

IsEnabledboolean

If true the customer is marked as active and can receive points and participate in the program points. If false the customer is inactive and will not receive points nor will be able to redeem rewards.

Reasonstring

The reason why the status has changed. This will not be visible to the customer only to administrators.

Response

ErrorMessagestring nullable

Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect Result, Code and Severity first.

ErrorCodeinteger nullable

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

Resultboolean

Business payload returned by the endpoint.

Codestring nullable

Endpoint-specific business code formatted as a two-digit string, such as 03 or 07. This field is available for success, warning and error outcomes.

CodeNamestring nullable

Symbolic enum name associated with Code, such as CheckoutNotFound.

Severity0 | 1 | 2

0 = Success 1 = Warning 2 = Error

HasWarningboolean

Convenience flag that is true when Severity is Warning. Warnings are valid 200 OK business outcomes and should not be handled as transport or validation errors.

HasErrorboolean

Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as false.