PLplugsign

POST Update team user

Changed on

Através deste endpoint é possível atualizar dados dos colaboradores ou permissões de acesso à plataforma.

Note que o e-mail não é passível de atualização, uma vez que é um identificador único. Portanto, caso seja necessário alterá-lo, recomendamos a exclusão da conta e a criação de uma nova.

(Caso não seja possível, solicite a alteração diretamente ao suporte)

Regras:

  • Se o colaborador 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.
  • E-mail que não pertence a um colaborador ou cliente da sua empresa responde 404.
post/api/teams/{email}

Request

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

Path parameters

emailstring required

E-mail do colaborador que deseja alterar.

Request body

namestring

Primeiro nome do colaborador.

last_namestring

Sobrenome do colaborador.

birthstring

Data de nascimento do colaborador 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.

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.

passwordstring

Nova senha de acesso do colaborador. Nenhuma senha é gerada nem enviada por e-mail neste endpoint.

permissionsstring[]

Novas permissões do colaborador (substituem as atuais).

status'Active' | 'Inactive' | 'Suspended'

Status do usuário.

role'admin' | 'user' | 'staff'

Cargo do usuário.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Colaboarador alterado 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

      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 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 new delete enum value to the request property /

    • info

      added the new edit enum value to the request property /

    • info

      added the new protect enum value to the request property /

    • info

      added the new send_request enum value to the request property /

    • info

      added the new upload enum value to the request property /

    • info

      added the new view_all_requests enum value to the request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status