Skip to main content
POST
/
v1
/
pvt
/
Affiliate
To create and update an affiliate, it's possible to create a customer for the same.
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Affiliate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "<string>",
  "Email": "<string>",
  "Document": "<string>",
  "Phone": "<string>",
  "Coupon": "<string>",
  "InviteToPortal": true,
  "CreateCustomer": true
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": true,
  "Code": "<string>",
  "CodeName": "<string>",
  "HasWarning": true,
  "HasError": true
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json
​
Name
string
​
Email
string | null

Email address of the affiliate, used in OriginalId

​
Document
string | null
​
Phone
string | null
​
Coupon
string | null

Affiliate code or coupon

​
InviteToPortal
boolean

Invite to affiliate portal, if the portal is active

​
CreateCustomer
boolean

Flag to create the customer in loyalty if not exists

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.