Update Customer

PUT /customers/{id}

Authorization

Path parameters

id string(uuid) Required

Body Required

zipCode string Required
gender string Required
document string Required
companyName string Required
stateAddress string Required
mothersFullName string Required
PLDistributionPercentage string Required
hasAssets boolean Required
automobileHeritage number Required
realEstate number Required
equityInvestments number Required
otherEquity number Required
equityValue number Required
occupationArea string Required
countryOfBirth string Required
stateBorn string Required
currentlyWorking boolean Required
cityAddress string Required
informedProfession string Required
id string Required
email string Required
monthlyIncome number Required
profession string Required
address string Required
maritalString string Required
dispatchingOrgan string Required
firstName string Required
lastName string Required
cityBorn string Required
issuingState string Required
dateOfIssue string Required
birthDate string Required
nationality string Required
phone string Required
rg string Required
mailingAddress string Required
PEP boolean Required
numberAddress string Required
neighborhood string Required
status number Required
cuc string Required
investorProfileLevel number Required
isQualifiedInvestor boolean Required
fees array[object] Required
Hide fees attributes Show fees attributes array[object]
- discount number Required
- type string Required
- paymentDay number Required
- begin string Required

Responses

200
Hide response attribute Show response attribute object
- updateCustomer object Required
  
  Hide updateCustomer attributes Show updateCustomer attributes object
  
  zipCode string Required
  
  gender string Required
  
  document string Required
  
  companyName string Required
  
  stateAddress string Required
  
  mothersFullName string Required
  
  PLDistributionPercentage string Required
  
  hasAssets boolean Required
  
  automobileHeritage number Required
  
  realEstate number Required
  
  equityInvestments number Required
  
  otherEquity number Required
  
  equityValue number Required
  
  occupationArea string Required
  
  countryOfBirth string Required
  
  stateBorn string Required
  
  currentlyWorking boolean Required
  
  cityAddress string Required
  
  informedProfession string Required
  
  id string Required
  
  email string Required
  
  monthlyIncome number Required
  
  profession string Required
  
  address string Required
  
  maritalString string Required
  
  dispatchingOrgan string Required
  
  firstName string Required
  
  lastName string Required
  
  cityBorn string Required
  
  issuingState string Required
  
  dateOfIssue string Required
  
  birthDate string Required
  
  nationality string Required
  
  phone string Required
  
  rg string Required
  
  mailingAddress string Required
  
  PEP boolean Required
  
  numberAddress string Required
  
  neighborhood string Required
  
  status number Required
  
  cuc string Required
  
  investorProfileLevel number Required
  
  isQualifiedInvestor boolean Required
  
  fees array[object] Required
  
  Hide fees attributes Show fees attributes array[object]
  
  discount number Required
  
  type string Required
  
  paymentDay number Required
  
  begin string Required
400
Hide response attributes Show response attributes object
- message object Required
- data object Required
401
Hide response attributes Show response attributes object
- message object Required
- data object Required

PUT /customers/{id}

curl \
 -X PUT https://open-api.hml.soupi.com.br/customers/{id} \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"zipCode":"string","gender":"string","document":"string","companyName":"string","stateAddress":"string","mothersFullName":"string","PLDistributionPercentage":"string","hasAssets":true,"automobileHeritage":42.0,"realEstate":42.0,"equityInvestments":42.0,"otherEquity":42.0,"equityValue":42.0,"occupationArea":"string","countryOfBirth":"string","stateBorn":"string","currentlyWorking":true,"cityAddress":"string","informedProfession":"string","id":"string","email":"string","monthlyIncome":42.0,"profession":"string","address":"string","maritalString":"string","dispatchingOrgan":"string","firstName":"string","lastName":"string","cityBorn":"string","issuingState":"string","dateOfIssue":"string","birthDate":"string","nationality":"string","phone":"string","rg":"string","mailingAddress":"string","PEP":true,"numberAddress":"string","neighborhood":"string","status":42.0,"cuc":"string","investorProfileLevel":42.0,"isQualifiedInvestor":true,"fees":[{"discount":42.0,"type":"string","paymentDay":42.0,"begin":"string"}]}'

Request example

{
  "zipCode": "string",
  "gender": "string",
  "document": "string",
  "companyName": "string",
  "stateAddress": "string",
  "mothersFullName": "string",
  "PLDistributionPercentage": "string",
  "hasAssets": true,
  "automobileHeritage": 42.0,
  "realEstate": 42.0,
  "equityInvestments": 42.0,
  "otherEquity": 42.0,
  "equityValue": 42.0,
  "occupationArea": "string",
  "countryOfBirth": "string",
  "stateBorn": "string",
  "currentlyWorking": true,
  "cityAddress": "string",
  "informedProfession": "string",
  "id": "string",
  "email": "string",
  "monthlyIncome": 42.0,
  "profession": "string",
  "address": "string",
  "maritalString": "string",
  "dispatchingOrgan": "string",
  "firstName": "string",
  "lastName": "string",
  "cityBorn": "string",
  "issuingState": "string",
  "dateOfIssue": "string",
  "birthDate": "string",
  "nationality": "string",
  "phone": "string",
  "rg": "string",
  "mailingAddress": "string",
  "PEP": true,
  "numberAddress": "string",
  "neighborhood": "string",
  "status": 42.0,
  "cuc": "string",
  "investorProfileLevel": 42.0,
  "isQualifiedInvestor": true,
  "fees": [
    {
      "discount": 42.0,
      "type": "string",
      "paymentDay": 42.0,
      "begin": "string"
    }
  ]
}

Request examples

{
  "zipCode": "string",
  "gender": "string",
  "document": "string",
  "companyName": "string",
  "stateAddress": "string",
  "mothersFullName": "string",
  "PLDistributionPercentage": "string",
  "hasAssets": true,
  "automobileHeritage": 42.0,
  "realEstate": 42.0,
  "equityInvestments": 42.0,
  "otherEquity": 42.0,
  "equityValue": 42.0,
  "occupationArea": "string",
  "countryOfBirth": "string",
  "stateBorn": "string",
  "currentlyWorking": true,
  "cityAddress": "string",
  "informedProfession": "string",
  "id": "string",
  "email": "string",
  "monthlyIncome": 42.0,
  "profession": "string",
  "address": "string",
  "maritalString": "string",
  "dispatchingOrgan": "string",
  "firstName": "string",
  "lastName": "string",
  "cityBorn": "string",
  "issuingState": "string",
  "dateOfIssue": "string",
  "birthDate": "string",
  "nationality": "string",
  "phone": "string",
  "rg": "string",
  "mailingAddress": "string",
  "PEP": true,
  "numberAddress": "string",
  "neighborhood": "string",
  "status": 42.0,
  "cuc": "string",
  "investorProfileLevel": 42.0,
  "isQualifiedInvestor": true,
  "fees": [
    {
      "discount": 42.0,
      "type": "string",
      "paymentDay": 42.0,
      "begin": "string"
    }
  ]
}

Response examples (200)

{
  "updateCustomer": {
    "zipCode": "string",
    "gender": "string",
    "document": "string",
    "companyName": "string",
    "stateAddress": "string",
    "mothersFullName": "string",
    "PLDistributionPercentage": "string",
    "hasAssets": true,
    "automobileHeritage": 42.0,
    "realEstate": 42.0,
    "equityInvestments": 42.0,
    "otherEquity": 42.0,
    "equityValue": 42.0,
    "occupationArea": "string",
    "countryOfBirth": "string",
    "stateBorn": "string",
    "currentlyWorking": true,
    "cityAddress": "string",
    "informedProfession": "string",
    "id": "string",
    "email": "string",
    "monthlyIncome": 42.0,
    "profession": "string",
    "address": "string",
    "maritalString": "string",
    "dispatchingOrgan": "string",
    "firstName": "string",
    "lastName": "string",
    "cityBorn": "string",
    "issuingState": "string",
    "dateOfIssue": "string",
    "birthDate": "string",
    "nationality": "string",
    "phone": "string",
    "rg": "string",
    "mailingAddress": "string",
    "PEP": true,
    "numberAddress": "string",
    "neighborhood": "string",
    "status": 42.0,
    "cuc": "string",
    "investorProfileLevel": 42.0,
    "isQualifiedInvestor": true,
    "fees": [
      {
        "discount": 42.0,
        "type": "string",
        "paymentDay": 42.0,
        "begin": "string"
      }
    ]
  }
}

Response examples (200)

{
  "updateCustomer": {
    "zipCode": "string",
    "gender": "string",
    "document": "string",
    "companyName": "string",
    "stateAddress": "string",
    "mothersFullName": "string",
    "PLDistributionPercentage": "string",
    "hasAssets": true,
    "automobileHeritage": 42.0,
    "realEstate": 42.0,
    "equityInvestments": 42.0,
    "otherEquity": 42.0,
    "equityValue": 42.0,
    "occupationArea": "string",
    "countryOfBirth": "string",
    "stateBorn": "string",
    "currentlyWorking": true,
    "cityAddress": "string",
    "informedProfession": "string",
    "id": "string",
    "email": "string",
    "monthlyIncome": 42.0,
    "profession": "string",
    "address": "string",
    "maritalString": "string",
    "dispatchingOrgan": "string",
    "firstName": "string",
    "lastName": "string",
    "cityBorn": "string",
    "issuingState": "string",
    "dateOfIssue": "string",
    "birthDate": "string",
    "nationality": "string",
    "phone": "string",
    "rg": "string",
    "mailingAddress": "string",
    "PEP": true,
    "numberAddress": "string",
    "neighborhood": "string",
    "status": 42.0,
    "cuc": "string",
    "investorProfileLevel": 42.0,
    "isQualifiedInvestor": true,
    "fees": [
      {
        "discount": 42.0,
        "type": "string",
        "paymentDay": 42.0,
        "begin": "string"
      }
    ]
  }
}

Response examples (400)

{
  "message": {},
  "data": {}
}

Response examples (400)

{
  "message": {},
  "data": {}
}

Response examples (401)

{
  "message": {},
  "data": {}
}

Response examples (401)

{
  "message": {},
  "data": {}
}