PLplugsign

POST Update customer

Changed on

Este endpoint permite que você edite as informações de um cliente de forma rápida.

O endereço de e-mail do seu cliente não pode ser editado, pois é uma chave primária essencial para o sistema.

Portanto, caso precise alterar o endereço de e-mail, sugerimos que exclua a conta do cliente e crie uma nova. Assim, garantimos que o cliente receba a senha de acesso corretamente.

Regras:

  • Se o cliente tem vínculo com mais de uma empresa, só cert_file e cert_password podem ser alterados; qualquer outro campo responde 401.
  • cert_file como arquivo exige multipart/form-data.
post/api/customers/{email}

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/customers/{email}
  • Auth
    API key in header Authorization

Path parameters

emailstring required

E-mail do cliente que deseja alterar.

Request body

namestring

Primeiro nome do cliente adicionado na plataforma.

last_namestring

Sobrenome do cliente adicionado na plataforma.

birthstring

Data de nascimento do cliente no formato ano-mês-dia. Exemplo: 1990-05-12.

phonestring

Telefone com DDD e 9 (ex.: 11999999999).

cpfstring

CPF válido, formatado ou apenas números.

addressstring

Endereço do seu cliente adicionado na plataforma.

recive_email0 | 1 | 2

Recebimento de e-mails: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações.

recive_whatsapp0 | 1 | 2

Recebimento de mensagens de WhatsApp: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações.

cert_filestring binary

Arquivo do certificado digital (.pfx ou .p12). Enviar como arquivo em multipart/form-data; cert_password é obrigatória junto.

cert_passwordstring

Senha do certificado. Obrigatória quando cert_file é enviado; senha errada responde 401.

signaturestring

Assinatura do customer em base64. Envie o conteúdo base64 puro ou uma data URI, como data:image/png;base64,.... O conteúdo precisa decodificar para uma imagem válida e ter até 5 MB. Se omitida na criação, a API tenta gerar uma assinatura padrão com o nome do customer.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Cliente atualizado com sucesso"
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from string to integer

    • breaking

      the request property type changed from string to integer

    • info

      added the new optional request property

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 0.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the new 2.00 enum value to the request property

    • info

      added the non-success response with the status