Editar Cliente

Uma vez que um cliente tenha sido criado, é possível realizar a edição de alguns dados.

Os campos editáveis são:

  • identificador externo (campo myId)
  • nome (campo name)
  • documento (campo document, CPF ou CNPJ, apenas números)
  • email (campo emails)
  • telefone (campo phones, não obrigatório)
  • endereço
    • CEP (campo zipcode, apenas números)
    • rua (campo street)
    • número (campo number)
    • complemento (campo complement)
    • bairro (campo neighborhood)
    • cidade (campo city)
    • estado (campo state)
📘

É possível editar um ou mais campos em uma única requisição.

Todos os campos preenchidos serão alterados.

Os campos não preenchidos permanecerão iguais.

Exemplo de Request

curl --request PUT \
     --url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/customers/{id}/{typeId}' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {TOKEN}' \
     --header 'content-type: application/json' \
     --data '
        {
            "myId": "pay-6998d318a7fdf5.74177539",
            "name": "Lorem ipsum dolor sit amet.",
            "document": "13520252139",
            "emails": [
                "[email protected]",
                "[email protected]"
            ],
            "phones": [
                3140201512,
                31983890110
            ],
            "Address": {
                "zipCode": "30411330",
                "street": "Rua platina",
                "number": "1330",
                "complement": "2º andar",
                "neighborhood": "Prado",
                "city": "Belo Horizonte",
                "state": "MG"
            }
        }'
👍

Sucesso 200

Exemplo de Response

{
    "type": true,
    "Customer": {
        "galaxPayId": 1,
        "myId": "pay-6998d318d00293.04855815",
        "name": "Lorem ipsum dolor sit amet.",
        "document": "39120067925",
        "emails": [
            "[email protected]",
            "[email protected]"
        ],
        "phones": [
            3140201512,
            31983890110
        ],
        "createdAt": "2020-06-02 10:10:00",
        "updatedAt": "2020-06-02 10:10:00",
        "Address": {
            "zipCode": "30411330",
            "street": "Rua platina",
            "number": "1330",
            "complement": "2º andar",
            "neighborhood": "Prado",
            "city": "Belo Horizonte",
            "state": "MG"
        }
    }
}

Para editar um cliente, utilize o endpoint Editar Cliente.