Skip to main content
POST
/
v1
/
pvt
/
Affiliate
Turn a customer into Affiliate, Change cupom and if necessary, create a customer
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,
  "HasError": true
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json
Name
string
Email
string | null
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
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.