curl --request PUT \
--url https://sandbox.api.veepag.com/v1/client \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"_id": "<string>",
"referenceId": "<string>",
"name": "<string>",
"birth": "<string>",
"email": "jsmith@example.com",
"phone": [
"<string>"
],
"note": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"complement": "<string>",
"zipcode": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"device": {
"colorDepth": 123,
"javaEnable": true,
"language": "<string>",
"screenHeight": 123,
"screenWidth": 123,
"timezoneOffset": 123,
"userAgent": "<string>",
"javaEnabled": true
},
"ipAddress": "<string>"
}
'import requests
url = "https://sandbox.api.veepag.com/v1/client"
payload = {
"_id": "<string>",
"referenceId": "<string>",
"name": "<string>",
"birth": "<string>",
"email": "jsmith@example.com",
"phone": ["<string>"],
"note": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"complement": "<string>",
"zipcode": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"device": {
"colorDepth": 123,
"javaEnable": True,
"language": "<string>",
"screenHeight": 123,
"screenWidth": 123,
"timezoneOffset": 123,
"userAgent": "<string>",
"javaEnabled": True
},
"ipAddress": "<string>"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '<string>',
referenceId: '<string>',
name: '<string>',
birth: '<string>',
email: 'jsmith@example.com',
phone: ['<string>'],
note: '<string>',
address: {
street: '<string>',
number: '<string>',
additionalDetails: '<string>',
complement: '<string>',
zipcode: '<string>',
neighborhood: '<string>',
city: '<string>',
state: '<string>',
country: '<string>'
},
device: {
colorDepth: 123,
javaEnable: true,
language: '<string>',
screenHeight: 123,
screenWidth: 123,
timezoneOffset: 123,
userAgent: '<string>',
javaEnabled: true
},
ipAddress: '<string>'
})
};
fetch('https://sandbox.api.veepag.com/v1/client', 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://sandbox.api.veepag.com/v1/client",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'_id' => '<string>',
'referenceId' => '<string>',
'name' => '<string>',
'birth' => '<string>',
'email' => 'jsmith@example.com',
'phone' => [
'<string>'
],
'note' => '<string>',
'address' => [
'street' => '<string>',
'number' => '<string>',
'additionalDetails' => '<string>',
'complement' => '<string>',
'zipcode' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>'
],
'device' => [
'colorDepth' => 123,
'javaEnable' => true,
'language' => '<string>',
'screenHeight' => 123,
'screenWidth' => 123,
'timezoneOffset' => 123,
'userAgent' => '<string>',
'javaEnabled' => true
],
'ipAddress' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$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://sandbox.api.veepag.com/v1/client"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"birth\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalDetails\": \"<string>\",\n \"complement\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"device\": {\n \"colorDepth\": 123,\n \"javaEnable\": true,\n \"language\": \"<string>\",\n \"screenHeight\": 123,\n \"screenWidth\": 123,\n \"timezoneOffset\": 123,\n \"userAgent\": \"<string>\",\n \"javaEnabled\": true\n },\n \"ipAddress\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("apiKey", "<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.put("https://sandbox.api.veepag.com/v1/client")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"birth\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalDetails\": \"<string>\",\n \"complement\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"device\": {\n \"colorDepth\": 123,\n \"javaEnable\": true,\n \"language\": \"<string>\",\n \"screenHeight\": 123,\n \"screenWidth\": 123,\n \"timezoneOffset\": 123,\n \"userAgent\": \"<string>\",\n \"javaEnabled\": true\n },\n \"ipAddress\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.veepag.com/v1/client")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"birth\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalDetails\": \"<string>\",\n \"complement\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"device\": {\n \"colorDepth\": 123,\n \"javaEnable\": true,\n \"language\": \"<string>\",\n \"screenHeight\": 123,\n \"screenWidth\": 123,\n \"timezoneOffset\": 123,\n \"userAgent\": \"<string>\",\n \"javaEnabled\": true\n },\n \"ipAddress\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "client_id",
"name": "Cliente Teste"
}{
"error_messages": [
{
"msg": "Payload invalido.",
"type": "field",
"path": "companyId",
"location": "body"
}
],
"code": "ZodValidationException",
"path": "/v1/client",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unauthorized."
}
],
"code": "unauthorized",
"path": "/v1/client",
"metadata": {}
}{
"error_messages": [
{
"msg": "Forbidden."
}
],
"code": "forbidden",
"path": "/v1/client",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unknown server error."
}
],
"code": "unknown_server_error",
"path": "/v1/client",
"metadata": {}
}Atualizar cliente (sem atualizar doc)
Atualiza dados de um cliente existente. O documento nao pode ser alterado por este endpoint.
curl --request PUT \
--url https://sandbox.api.veepag.com/v1/client \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"_id": "<string>",
"referenceId": "<string>",
"name": "<string>",
"birth": "<string>",
"email": "jsmith@example.com",
"phone": [
"<string>"
],
"note": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"complement": "<string>",
"zipcode": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"device": {
"colorDepth": 123,
"javaEnable": true,
"language": "<string>",
"screenHeight": 123,
"screenWidth": 123,
"timezoneOffset": 123,
"userAgent": "<string>",
"javaEnabled": true
},
"ipAddress": "<string>"
}
'import requests
url = "https://sandbox.api.veepag.com/v1/client"
payload = {
"_id": "<string>",
"referenceId": "<string>",
"name": "<string>",
"birth": "<string>",
"email": "jsmith@example.com",
"phone": ["<string>"],
"note": "<string>",
"address": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"complement": "<string>",
"zipcode": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"device": {
"colorDepth": 123,
"javaEnable": True,
"language": "<string>",
"screenHeight": 123,
"screenWidth": 123,
"timezoneOffset": 123,
"userAgent": "<string>",
"javaEnabled": True
},
"ipAddress": "<string>"
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
_id: '<string>',
referenceId: '<string>',
name: '<string>',
birth: '<string>',
email: 'jsmith@example.com',
phone: ['<string>'],
note: '<string>',
address: {
street: '<string>',
number: '<string>',
additionalDetails: '<string>',
complement: '<string>',
zipcode: '<string>',
neighborhood: '<string>',
city: '<string>',
state: '<string>',
country: '<string>'
},
device: {
colorDepth: 123,
javaEnable: true,
language: '<string>',
screenHeight: 123,
screenWidth: 123,
timezoneOffset: 123,
userAgent: '<string>',
javaEnabled: true
},
ipAddress: '<string>'
})
};
fetch('https://sandbox.api.veepag.com/v1/client', 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://sandbox.api.veepag.com/v1/client",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'_id' => '<string>',
'referenceId' => '<string>',
'name' => '<string>',
'birth' => '<string>',
'email' => 'jsmith@example.com',
'phone' => [
'<string>'
],
'note' => '<string>',
'address' => [
'street' => '<string>',
'number' => '<string>',
'additionalDetails' => '<string>',
'complement' => '<string>',
'zipcode' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>'
],
'device' => [
'colorDepth' => 123,
'javaEnable' => true,
'language' => '<string>',
'screenHeight' => 123,
'screenWidth' => 123,
'timezoneOffset' => 123,
'userAgent' => '<string>',
'javaEnabled' => true
],
'ipAddress' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$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://sandbox.api.veepag.com/v1/client"
payload := strings.NewReader("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"birth\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalDetails\": \"<string>\",\n \"complement\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"device\": {\n \"colorDepth\": 123,\n \"javaEnable\": true,\n \"language\": \"<string>\",\n \"screenHeight\": 123,\n \"screenWidth\": 123,\n \"timezoneOffset\": 123,\n \"userAgent\": \"<string>\",\n \"javaEnabled\": true\n },\n \"ipAddress\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("apiKey", "<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.put("https://sandbox.api.veepag.com/v1/client")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"birth\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalDetails\": \"<string>\",\n \"complement\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"device\": {\n \"colorDepth\": 123,\n \"javaEnable\": true,\n \"language\": \"<string>\",\n \"screenHeight\": 123,\n \"screenWidth\": 123,\n \"timezoneOffset\": 123,\n \"userAgent\": \"<string>\",\n \"javaEnabled\": true\n },\n \"ipAddress\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.api.veepag.com/v1/client")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"_id\": \"<string>\",\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"birth\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalDetails\": \"<string>\",\n \"complement\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"device\": {\n \"colorDepth\": 123,\n \"javaEnable\": true,\n \"language\": \"<string>\",\n \"screenHeight\": 123,\n \"screenWidth\": 123,\n \"timezoneOffset\": 123,\n \"userAgent\": \"<string>\",\n \"javaEnabled\": true\n },\n \"ipAddress\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "client_id",
"name": "Cliente Teste"
}{
"error_messages": [
{
"msg": "Payload invalido.",
"type": "field",
"path": "companyId",
"location": "body"
}
],
"code": "ZodValidationException",
"path": "/v1/client",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unauthorized."
}
],
"code": "unauthorized",
"path": "/v1/client",
"metadata": {}
}{
"error_messages": [
{
"msg": "Forbidden."
}
],
"code": "forbidden",
"path": "/v1/client",
"metadata": {}
}{
"error_messages": [
{
"msg": "Unknown server error."
}
],
"code": "unknown_server_error",
"path": "/v1/client",
"metadata": {}
}Authorizations
API key no formato keyId.secret.
Body
ID do cliente que sera atualizado.
1Tipo do cliente, conforme enum aceito pela API.
INDIVIDUAL, COMPANY Identificador externo da sua aplicacao para conciliacao.
Nome atualizado do cliente. Nao aceita numeros ou caracteres especiais.
Data de nascimento do cliente, quando disponivel.
E-mail do cliente.
Lista de telefones do cliente.
Observacao interna sobre o cliente.
Endereco do cliente.
Show child attributes
Show child attributes
Dados do dispositivo do cliente, quando coletados no fluxo de compra.
Show child attributes
Show child attributes
IP do cliente, quando disponivel.
Response
Cliente atualizado.
ID do cliente.
ID da empresa vinculada ao cliente.
Nome do cliente.
Documento do cliente.
CPF do cliente, quando presente no payload legado.
E-mail do cliente.
Telefones do cliente.
Status do cliente.
ACTIVE, ERROR_PAYMENT, PENDING_PAYMENT, NO_PAYMENT, CANCELED_ALERT_ETHOCA Tipo do cliente.
INDIVIDUAL, COMPANY Indica se o cliente esta ativo.
Indica exclusao logica do cliente, quando preenchido.
Referencia externa da sua aplicacao.
Data de criacao do cliente.
Data da ultima atualizacao do cliente.
Was this page helpful?
