Customer upsert

This endpoint will receive and queue up to 50 customers at a time. There is no rate limit.

No customer data will be returned in this request. It just gets the data, validates some parameters and recovers the success of the queuing process. All customers can be retrieved via the GET Customer endpoint.

You can test this endpoint accessing: Upsert a customer

Parameters

This endpoint receives the following parameters:

address_city [String - Mandatory - Not Empty]

Contains your customer city address.

Example: "São Paulo"

address_complement [String - Mandatory - Not Empty]

Contains the complement for your customer address.

Example: "Second Floor"

address_neighborhood [String - Mandatory - Not Empty]

Contains the neighborhood of your customer address.

Example: "Brooklyn"

address_number [String - Mandatory - Not Empty]

Contains the number related to your customer address.

Example: "356"

address_state [String - Mandatory - Not Empty]

Contains the State abbreviation where your customer is located.

Example: "SP"

Possible values:

Acre (AC)

Alagoas (AL)

Amapá (AP)

Amazonas (AM)

Bahia (BA)

Ceará (CE)

Distrito Federal (DF)

Espírito Santo (ES)

Goiás (GO)

Maranhão (MA)

Mato Grosso (MT)

Mato Grosso do Sul (MS)

Minas Gerais (MG)

Pará (PA)

Paraíba (PB)

Paraná (PR)

Pernambuco (PE)

Piauí (PI)

Rio de Janeiro (RJ)

Rio Grande do Norte (RN)

Rio Grande do Sul (RS)

Rondônia (RO)

Roraima (RR)

Santa Catarina (SC)

São Paulo (SP)

Sergipe (SE)

Tocantins (TO)

address_street [String - Mandatory - Not Empty]

The street name of your customer address.

Example: "Avenida Paulista"

address_zip_code [String - Mandatory - Not Empty]

The zip code of your customer address.

Example: "01405-001"

document [String - Mandatory - Not Empty]

CPF (brazilian social document for a person) or CNPJ (brazilian social document for a company). CPF must have 11 numbers and a CNPJ must have 14 numbers.

Example: "75730786000100"

mail [String - Mandatory - Not Empty]

The main email address where your customer will receive billing/invoice communications.

Example: "customer@gmail.com"

name [String - Mandatory - Not Empty]

Your customer name.

Example: "Maria Quinteros" or "Company XPTO Inc"

phone [String - Mandatory - Not Empty]

Your customer phone number, able to receive billing information by whatsapp containing Country Code

+ Region Code + Phone Number.

Example: "+5511987654321"

secondary_phone [String - Optional - Empty]

Your customer secondary phone number, able to receive billing information by whatsapp containing Country Code + Region Code + Phone Number

Example: "+5511987654321"

How to upsert a customer

Customer upsert#

Parameters#

address_city [String - Mandatory - Not Empty]#

address_complement [String - Mandatory - Not Empty]#

address_neighborhood [String - Mandatory - Not Empty]#

address_number [String - Mandatory - Not Empty]#

address_state [String - Mandatory - Not Empty]#

address_street [String - Mandatory - Not Empty]#

address_zip_code [String - Mandatory - Not Empty]#

document [String - Mandatory - Not Empty]#

mail [String - Mandatory - Not Empty]#

name [String - Mandatory - Not Empty]#

phone [String - Mandatory - Not Empty]#

secondary_phone [String - Optional - Empty]#

Your customer secondary phone number, able to receive billing information by whatsapp containing Country Code + Region Code + Phone Number#