Bloquear cliente
Muda o status do cliente para BLOCKED, impedindo que ele seja usado em novas assinaturas.
apiKeyAuthorizationBearer <token>Chave de API da conta: Authorization: Bearer <chave de API>.
id*stringId do cliente.
Cliente bloqueado.
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 POST 'https://api.gates2b.com/customer/string/block'{ "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"}Exemplo
curl -X POST "https://api.gates2b.com/customer/01JB7Z1A2B3C4D5E6F7G8H9J0K/block" \
-H "Authorization: Bearer $API_KEY"A resposta traz o cliente com status: BLOCKED.
Regras
- Com o cliente bloqueado, Criar assinatura com o
customerIddele responde400. - O bloqueio não cancela nem pausa as assinaturas que o cliente já tem. Para parar de cobrar, use Cancelar assinatura.
- O cliente bloqueado continua contando como duplicata em Cadastrar cliente.
- Para reverter, use Desbloquear cliente.