BObonifiq
Affiliate

To create and update an affiliate, it's possible to create a customer for the same.

Changed on
post/v1/pvt/Affiliate

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Request body

Namestring
Emailstring nullable

Email address of the affiliate, used in OriginalId

Documentstring nullable
Phonestring nullable
Couponstring nullable

Affiliate code or coupon

InviteToPortalboolean

Invite to affiliate portal, if the portal is active

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.

Changes