Editar cliente

PUT /customers/{customerId}/{typeId}

Para utilizar esse método, o access_token deve conter o scope customers.write

Método utilizado para editar informações dos clientes dentro do sistema.

Dados da requisição

Você pode alterar todos os dados abaixo do registro ou apenas o campo que desejar.
Apenas os campos enviados serão validados.

Nome

Tipo

Obrigatório

Explicação

myId

string 255 caracteres

Sim

Id referente no seu sistema, para salvar no cel_cash.

name

string 255 caracteres

Sim

Nome ou razão social do cliente.

document

string 14 caracteres

Sim

CPF OU CNPJ do cliente. Apenas números.

emails

array de string 255 caracteres

Sim

Emails do cliente. Separe cada email por vírgula.

phones

array de int 11 dígitos

Não

Telefones do cliente. Separe cada telefone por vírgula.

Address

Sim para cobranças por boleto

Endereço de cobrança do cliente.
Caso deseja utilizar o cliente para realizar cobranças de boleto, o endereço se torna obrigatório.
Clique para ver os campos.

zipCode

string 8 caracteres

Sim

CEP. Informe apenas números.

street

string 255 caracteres

Sim

Logradouro.

number

string 255 caracteres

Sim

Número.

complement

string 255 caracteres

Não

Complemento.

neighborhood

string 255 caracteres

Sim

Bairro.

city

string 255 caracteres

Sim

Cidade.

state

string 2 caracteres

Sim

Estado.

Parâmetros da URL:

{customerId}: Id do cliente a ser alterado.
{typeId}: Tipo do id. Opções:
- galaxPayId: Id no cel_cash
- myId: Id referente no seu sistema, para salvar no cel_cash.

URL da Requisição

https://api.sandbox.cel.cash/v2/customers/ /

URL da Requisição

https://api.sandbox.cel.cash/v2/customers/1/myId

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Customer": {
        "galaxPayId": 1,
        "myId": "pay-664ae7c810b0b6.54821934",
        "name": "Lorem ipsum dolor sit amet.",
        "document": "20217907970",
        "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"
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Customer

Informações do cliente.
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

name

string 255 caracteres

Nome ou razão social do cliente.

document

string 14 caracteres

CPF OU CNPJ do cliente. Apenas números.

emails

array de string 255 caracteres

Emails do cliente.

phones

array de int 11 dígitos

Telefones do cliente.

createdAt

datetime

Data de criação.

updatedAt

datetime

Data de alteração.

Address

Endereço de cobrança do cliente.
Clique para ver os campos.

zipCode

string 8 caracteres

CEP

street

string 255 caracteres

Logradouro.

number

string 255 caracteres

Número.

complement

string 255 caracteres

Complemento.

neighborhood

string 255 caracteres

Bairro.

city

string 255 caracteres

Cidade.

state

string 2 caracteres

Estado.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Cliente alterado com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Cliente não encontrado.