Atualizar cliente
Altera os dados enviados de um cliente. null apaga o campo; os ausentes ficam como estão.
apiKeyAuthorizationBearer <token>Chave de API da conta: Authorization: Bearer <chave de API>.
id*stringId do cliente.
application/json- body
Envie só o que vai mudar. null apaga o campo (exceto name).
name?stringNome do cliente. Não pode ficar vazio.
1 <= length <= 150email?|E-mail. Gravado em minúsculas.
length <= 255phone?|Telefone com DDI e DDD. Gravado só com dígitos.
length <= 32taxID?|CPF ou CNPJ. Gravado só com dígitos.
length <= 20address?Endereço. Cada campo enviado é alterado; os ausentes ficam como estão.
Cliente atualizado.
application/json- response
Cliente da conta. taxID, email e phone vêm mascarados; o endereço
vem em campos separados (addressZipcode, addressStreet…).
id?stringId do cliente (ULID). É o valor de customerId em Criar assinatura.
name?stringtaxID?|CPF/CNPJ mascarado (três primeiros e dois últimos dígitos).
email?|E-mail mascarado (dois primeiros caracteres e domínio).
phone?|Telefone mascarado (dois primeiros e dois últimos dígitos).
addressZipcode?string|nulladdressStreet?string|nulladdressNumber?string|nulladdressNeighborhood?string|nulladdressCity?string|nulladdressState?string|nulladdressComplement?string|nulladdressCountry?string|nullstatus?CustomerStatusACTIVE ou BLOCKED (bloqueado por você).
"ACTIVE""BLOCKED"customerIdentityId?|Preenchido quando o cliente cria acesso ao portal do assinante. null até lá.
invitedAt?|Quando o convite foi emitido (modo B).
date-timeactivatedAt?|Quando o cadastro ficou completo. No modo A, na criação.
date-timecreatedAt?stringdate-timeupdatedAt?stringdate-timecurl -X PATCH 'https://api.gates2b.com/customer/string' \ -H 'Content-Type: application/json' \ -d '{ "phone": "5511988887777", "address": { "number": "1200", "complement": null }}'{ "id": "string", "name": "string", "taxID": "string", "email": "string", "phone": "string", "addressZipcode": "string", "addressStreet": "string", "addressNumber": "string", "addressNeighborhood": "string", "addressCity": "string", "addressState": "string", "addressComplement": "string", "addressCountry": "string", "status": "ACTIVE", "customerIdentityId": "string", "invitedAt": "2019-08-24T14:15:22Z", "activatedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Regras
- Envie os dados sem máscara. A resposta volta mascarada.
nullapaga o campo.namenão pode ficar vazio.- No
address, cada campo enviado é alterado e os ausentes ficam como estão. A resposta traz o endereço em campos separados (addressZipcode…). - E-mail ou telefone já usados por outro cliente da conta respondem
409. - As assinaturas existentes não mudam: elas guardam a cópia dos dados feita na
criação, em
customerMeta.