On this page:
https://api.premepay.com/v1/stores/:id/customers/:id
You can edit a customer to update their registration data or add missing information. For example, to generate a sale with PIX and Credit Card, you may not need the customer's address, but for issuing a Bank Slip, the Central Bank of Brazil requires this information.
Keeping your customers' data up-to-date is essential for the smooth operational functioning of your business.
To update a customer's data, you need to provide all the values of that customer, even if there is no change for a specific value. If any value is not provided, it will be considered as null.
Parameters | Type | Description | Required |
---|---|---|---|
firstName |
string | First name or Corporate name | Yes |
surname |
string | Surname | No |
identificationNumber |
string | CPF or CNPJ | No |
birthdate |
date | Birth date | No |
email |
string | Yes | |
phone |
string | Telefone | No |
address |
object | Addresss | No |
street |
string | Street | No |
number |
string | Number | No |
reference |
string | Reference | No |
district |
string | District | No |
city |
string | City | No |
state |
int | State | No |
country |
int | Country | No |
zipcode |
string | Zip code | No |
This is an example of how your request to edit the data of a Consumer should look like:
If your request is successful, you will receive the consumer object as the response.
200: OK
400: Bad Request
401: Unauthorized
403: Forbidden
500: Internal Server Error
Related Content
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - List customers
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Add card
</aside>