Disables an affiliate by email or document.

curl --request DELETE \
  --url https://api.bonifiq.com.br/v1/pvt/Affiliate/disable/{originalId} \
  --header 'Authorization: Basic <encoded-value>'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": true,
  "HasError": true
}

DELETE

pvt

Affiliate

disable

{originalId}

Disables an affiliate by email or document.

curl --request DELETE \
  --url https://api.bonifiq.com.br/v1/pvt/Affiliate/disable/{originalId} \
  --header 'Authorization: Basic <encoded-value>'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": true,
  "HasError": true
}

Authorization

string

header

required

Use API Basic Auth Keys

originalId

string

required

Affiliate Id

reason

string | null

Reason for disabling the affiliate.

200 - application/json

BaseExternalApiResponse indicating success or error

ErrorMessage

string | null

Error message or description

ErrorCode

integer<int32> | null

Optional error code, if available

Result

boolean

HasError

boolean

If true the request had an error.