Skip to main content
PUT
/
v1
/
client
Atualizar cliente (sem atualizar doc)
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>"
}
'
{
  "_id": "client_id",
  "name": "Cliente Teste"
}

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
_id
string
required
Minimum string length: 1
type
enum<string> | null
Available options:
INDIVIDUAL,
COMPANY
referenceId
string | null
name
string | null
birth
string | null
email
string<email> | null
phone
string[] | null
note
string | null
address
object
device
object
ipAddress
string | null

Response

Cliente atualizado.

_id
string
companyId
string
name
string
doc
string
cpf
string
email
string<email>
phone
string[]
status
enum<string>
Available options:
ACTIVE,
ERROR_PAYMENT,
PENDING_PAYMENT,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA
type
enum<string>
Available options:
INDIVIDUAL,
COMPANY
active
boolean
deleted
boolean
referenceId
string
createdAt
string<date-time>
lastUpdate
string<date-time>