Skip to main content
PUT
/
v1
/
pvt
/
Customer
/
{id}
Update a customer based on the Id from the client store
curl --request PUT \
  --url https://api.bonifiq.com.br/v1/pvt/Customer/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalId": "<string>",
  "Name": "<string>",
  "Email": "<string>",
  "Phone": "<string>",
  "BirthdayDate": "2023-11-07T05:31:56Z",
  "SignupDate": "2023-11-07T05:31:56Z",
  "Document": "<string>",
  "IsEnrolled": true
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "OriginalId": "<string>",
    "PublicId": "<string>",
    "Name": "<string>",
    "Email": "<string>",
    "Phone": "<string>",
    "BirthdayDate": "2023-11-07T05:31:56Z",
    "SignupDate": "2023-11-07T05:31:56Z",
    "Document": "<string>",
    "IsEnrolled": true,
    "ReferralURL": "<string>",
    "WhatsappReferralUrl": "<string>",
    "CurrentTier": {
      "Name": "<string>",
      "Color": "<string>",
      "IconUrl": "<string>"
    }
  },
  "HasError": true
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
id
string
required

Id from the store registration

Body

application/json

Customer Data

Creater Customer body Request

​
OriginalId
string

This is the Id in the client store.

​
Name
string

Customer name.

​
Email
string | null

Customer email.

​
Phone
string | null

Customer Contact Phone.

​
BirthdayDate
string<date-time> | null

Customer Birthdate.

​
SignupDate
string<date-time> | null

Date when the customer made the register on client store.

​
Document
string | null

Some document number from the customer, accepts any string.

​
IsEnrolled
boolean

If true the customer is participating on the points plan from the store.

Response

200 - application/json
​
ErrorMessage
string | null

Error message or description

​
ErrorCode
integer<int32> | null

Optional error code, if available

​
Result
object
​
HasError
boolean

If true the request had an error.