Criar um novo cliente

curl --request POST \ --url https://{site}.payloop.dev/api/customers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "email": "[email protected]", "first_name": "John", "last_name": "Doe", "address": "Av. Paulista, 1000", "address_2": "Apto 101", "city": "São Paulo", "state": "SP", "zip": "01310100", "country": "BR", "phone": "5511999999999", "document_number": "12345678901" } '

{ "data": { "id": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "email": "[email protected]", "first_name": "John", "last_name": "Doe", "address": "Av. Paulista, 1000", "address_2": "Apto 101", "city": "São Paulo", "state": "SP", "zip": "01310100", "country": "BR", "phone": "11999999999", "document_number": "63054375056 ou 41903356000112" }, "errors": "<string>", "meta": {} }

Authorizations

Authorization

string

header

required

Cabeçalho de autenticação no formato Bearer token.

Body

application/json

Payload da requisição para criação de um cliente.

string

required

Email do cliente

Example:

"[email protected]"

first_name

string

required

Primeiro nome do cliente

Example:

"John"

last_name

string

required

Sobrenome do cliente

Example:

"Doe"

phone

string | null

required

Telefone de contato do seu cliente

Example:

"11999999999"

document_number

string

required

Número do CPF ou CNPJ do cliente

Example:

"63054375056 ou 41903356000112"

address

string | null

Endereço principal do cliente

Example:

"Av. Paulista, 1000"

address_2

string | null

Endereço secundário do cliente

Example:

"Apto 101"

city

string | null

Cidade do cliente

Example:

"São Paulo"

state

string | null

Estado que seu cliente reside

Example:

"SP"

zip

string | null

Código postal do cliente

Example:

"01310100"

country

string | null

País onde o cliente reside

Example:

"BR"

Response

Cliente criado com sucesso.

Objeto de resposta do cliente.

data

object

Estrutura base de dados de um cliente.

Show child attributes

errors

string | null