Atualizar cliente

curl --request PATCH \
  --url https://besimplo.com/api/v1/customers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
    "identifier": "123.456.789-00",
    "name": "João Silva",
    "email": "joao.silva@exemplo.com",
    "phone": "+5511999998888"
  }
}
'

import requests

url = "https://besimplo.com/api/v1/customers/{id}"

payload = { "customer": {
        "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
        "identifier": "123.456.789-00",
        "name": "João Silva",
        "email": "joao.silva@exemplo.com",
        "phone": "+5511999998888"
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer: {
      external_code: '01953808-3a3a-712f-99ce-f6943c8141db',
      identifier: '123.456.789-00',
      name: 'João Silva',
      email: 'joao.silva@exemplo.com',
      phone: '+5511999998888'
    }
  })
};

fetch('https://besimplo.com/api/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://besimplo.com/api/v1/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => [
        'external_code' => '01953808-3a3a-712f-99ce-f6943c8141db',
        'identifier' => '123.456.789-00',
        'name' => 'João Silva',
        'email' => 'joao.silva@exemplo.com',
        'phone' => '+5511999998888'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://besimplo.com/api/v1/customers/{id}"

	payload := strings.NewReader("{\n  \"customer\": {\n    \"external_code\": \"01953808-3a3a-712f-99ce-f6943c8141db\",\n    \"identifier\": \"123.456.789-00\",\n    \"name\": \"João Silva\",\n    \"email\": \"joao.silva@exemplo.com\",\n    \"phone\": \"+5511999998888\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://besimplo.com/api/v1/customers/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"external_code\": \"01953808-3a3a-712f-99ce-f6943c8141db\",\n    \"identifier\": \"123.456.789-00\",\n    \"name\": \"João Silva\",\n    \"email\": \"joao.silva@exemplo.com\",\n    \"phone\": \"+5511999998888\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://besimplo.com/api/v1/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": {\n    \"external_code\": \"01953808-3a3a-712f-99ce-f6943c8141db\",\n    \"identifier\": \"123.456.789-00\",\n    \"name\": \"João Silva\",\n    \"email\": \"joao.silva@exemplo.com\",\n    \"phone\": \"+5511999998888\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cus_01h455vb4pex5vsknk084sn02q",
  "object": "customer",
  "live_mode": true,
  "created": 1680893993,
  "name": "João Silva",
  "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
  "identifier": "123.456.789-00",
  "email": "joao.silva@exemplo.com",
  "phone": "+5511999998888",
  "description": "individual",
  "address": {
    "zip_code": "12345012",
    "street": "Alguma Rua",
    "number": "9934",
    "district": "D'algum Bairro",
    "city": "Campinas",
    "state": "SP",
    "complement": "Apt. 123"
  }
}

PATCH

api

customers

{id}

Atualizar cliente

curl --request PATCH \
  --url https://besimplo.com/api/v1/customers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
    "identifier": "123.456.789-00",
    "name": "João Silva",
    "email": "joao.silva@exemplo.com",
    "phone": "+5511999998888"
  }
}
'

import requests

url = "https://besimplo.com/api/v1/customers/{id}"

payload = { "customer": {
        "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
        "identifier": "123.456.789-00",
        "name": "João Silva",
        "email": "joao.silva@exemplo.com",
        "phone": "+5511999998888"
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer: {
      external_code: '01953808-3a3a-712f-99ce-f6943c8141db',
      identifier: '123.456.789-00',
      name: 'João Silva',
      email: 'joao.silva@exemplo.com',
      phone: '+5511999998888'
    }
  })
};

fetch('https://besimplo.com/api/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://besimplo.com/api/v1/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => [
        'external_code' => '01953808-3a3a-712f-99ce-f6943c8141db',
        'identifier' => '123.456.789-00',
        'name' => 'João Silva',
        'email' => 'joao.silva@exemplo.com',
        'phone' => '+5511999998888'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://besimplo.com/api/v1/customers/{id}"

	payload := strings.NewReader("{\n  \"customer\": {\n    \"external_code\": \"01953808-3a3a-712f-99ce-f6943c8141db\",\n    \"identifier\": \"123.456.789-00\",\n    \"name\": \"João Silva\",\n    \"email\": \"joao.silva@exemplo.com\",\n    \"phone\": \"+5511999998888\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://besimplo.com/api/v1/customers/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"external_code\": \"01953808-3a3a-712f-99ce-f6943c8141db\",\n    \"identifier\": \"123.456.789-00\",\n    \"name\": \"João Silva\",\n    \"email\": \"joao.silva@exemplo.com\",\n    \"phone\": \"+5511999998888\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://besimplo.com/api/v1/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": {\n    \"external_code\": \"01953808-3a3a-712f-99ce-f6943c8141db\",\n    \"identifier\": \"123.456.789-00\",\n    \"name\": \"João Silva\",\n    \"email\": \"joao.silva@exemplo.com\",\n    \"phone\": \"+5511999998888\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cus_01h455vb4pex5vsknk084sn02q",
  "object": "customer",
  "live_mode": true,
  "created": 1680893993,
  "name": "João Silva",
  "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
  "identifier": "123.456.789-00",
  "email": "joao.silva@exemplo.com",
  "phone": "+5511999998888",
  "description": "individual",
  "address": {
    "zip_code": "12345012",
    "street": "Alguma Rua",
    "number": "9934",
    "district": "D'algum Bairro",
    "city": "Campinas",
    "state": "SP",
    "complement": "Apt. 123"
  }
}

Authorizations

Authorization

string

header

required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Path Parameters

string

required

ID do cliente.

Pattern: ^cus_[0-9a-z]{26}$

Example:

"cus_01h455vb4pex5vsknk084sn02p"

Body

application/json

Dados do cliente que serão atualizados

customer

object

required

Show child attributes

Response

Operação realizada com sucesso

string

required

read-only

ID único do cliente, no formato TypeID com prefixo cus_.

Pattern: ^cus_[0-9a-z]{26}$

Example:

"cus_01h455vb4pex5vsknk084sn02q"

object

enum<string>

required

Tipo do objeto. Sempre 'customer'.

Available options:

customer

Example:

"customer"

live_mode

boolean

required

Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.

Example:

true

created

integer<int64>

required

read-only

Timestamp Unix de quando o cliente foi criado.

Example:

1680893993

name

string

required

Nome do cliente.

Required string length: 1 - 250

Example:

"João Silva"

external_code

string | null

Código externo para integração. Deve ser único por conta.

Example:

"01953808-3a3a-712f-99ce-f6943c8141db"

identifier

string | null

CPF ou CNPJ do cliente.

Example:

"123.456.789-00"

string | null

E-mail do cliente.

Example:

"joao.silva@exemplo.com"

phone

string | null

Telefone do cliente.

Example:

"+5511999998888"

description

string | null

Tipo de cliente baseado no documento: 'individual' para CPF, 'business' para CNPJ.

Available options:

individual,

business

Example:

"individual"

address

object

Show child attributes

Visão geral

Endpoints

Atualizar cliente

Authorizations

Path Parameters

Body

Response