Skip to main content
POST
/
v1
/
pvt
/
Customer
/
{originalId}
/
changestatus
Change the Status of the customer in BonifiQ
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Customer/{originalId}/changestatus \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "IsEnabled": true,
  "Reason": "<string>"
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": true,
  "Code": "<string>",
  "CodeName": "<string>",
  "HasWarning": true,
  "HasError": true
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
originalId
string
required

Body

application/json
​
IsEnabled
boolean

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.

​
Reason
string

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

Response

200 - application/json

Standard response envelope used by the External API.

​
ErrorMessage
string | null

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

​
ErrorCode
integer<int32> | null

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

​
Result
boolean

Business payload returned by the endpoint.

​
Code
string | null

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.

​
CodeName
string | null

Symbolic enum name associated with Code, such as CheckoutNotFound.

​
Severity
enum<integer>

Final severity of the response. Success means the action completed as expected, Warning means the request was valid but the business outcome is informational or non-ideal, and Error means the request should be treated as a failure.

Available options:
0,
1,
2
​
HasWarning
boolean

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.

​
HasError
boolean

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.