PLplugsign

POST Update company

Changed on

Com este endpoint, você pode atualizar os dados de uma subconta previamente criada no sistema.

As informações modificadas serão aplicadas imediatamente, e a subconta continuará funcionando normalmente com o token já existente.

Disponível apenas para contas revendedoras (outras contas recebem 501).

Regras:

  • company_name é o nome da empresa cadastrada; name é o nome curto (2 a 64 caracteres).
  • company_brand e company_icon são imagens (PNG ou JPG) e exigem multipart/form-data.
  • status é aplicado à subconta e a todos os usuários dela.
  • Corpo vazio ou sem nenhum campo válido responde 422.
  • limits só pode ser enviado por uma conta revendedora principal (subcontas recebem 403).
post/api/companies/{id}

Request

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

Path parameters

idinteger required

ID da company que deve ser alterada.

Request body

namestring

Nome curto da empresa (2 a 64 caracteres). Para o nome da empresa cadastrada use company_name.

company_brandstring binary

Logo da empresa (imagem PNG ou JPG, multipart/form-data).

company_iconstring binary

Ícone da empresa (imagem PNG ou JPG, multipart/form-data).

phonestring

Telefone da empresa, somente números com DDD (10 a 15 caracteres).

cnpjstring

CNPJ da empresa, formatado ou apenas números.

addressstring

Endereço da empresa (2 a 255 caracteres).

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

Status da subconta, aplicado também a todos os usuários dela: Active, Inactive ou Suspended.

can_loginboolean

Preencha este campo com 1 se a empresa está autorizada a acessar o sistema, e com 0 se não está autorizada.

payment_endstring

Fim de vigência no formato d/m/Y (ex.: 31/12/2026). Precisa ser posterior à data atual.

editablevalidateinteger

Tipo de validação padrão ao assinar um documento. <br><br> 7 - QR Code (Texto) na lateral direita. <br><br> 6 - QR Code (Texto) na lateral esquerda. <br><br> 5 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). <br><br> 4 - QR Code no rodapé do documento (Sem página final). <br><br> 3 - Página final de validação e QR Code. <br><br> 2 - Sem QR Code no topo, apenas página no final. <br><br> 1 - QR Code no topo do documento (Sem página final). <br><br> Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente

unlimitedboolean

Quando true/1, nenhum limite personalizado é aplicado à subconta.

webhook_header_namestring

Nome do header customizado que é enviado no envio dos webhook para a URI cadastrada.

webhook_header_valuestring

Valor do header customizado que é enviado no envio dos webhook para a URI cadastrada.

reseller_loginboolean

Define se a empresa revendedora está autorizada a realizar login na subconta para fins de suporte. Quando habilitado (true), o administrador da revendedora poderá acessar a conta da parceira de forma ilimitada. Quando desabilitado (false), esse acesso é bloqueado.

company_namestring

Nome da empresa cadastrada (2 a 255 caracteres).

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

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

Changes

  • 3db1513040eaRevision changes
    • breaking

      the request property's minLength was increased from 0 to 2

    • breaking

      the request property's minLength was increased from 0 to 2

    • breaking

      the request property's minLength was increased from 0 to 2

    • breaking

      the request property's minLength was increased from 0 to 10

    • breaking

      the request property type changed from integer to boolean, and format from int32 to no format

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 64

    • warning

      the request property's maxLength was set to 64

    • warning

      the request property's maxLength was set to 15

    • warning

      the request property's max was set to 7.00

    • warning

      the request property's min was set to 1.00

    • info

      added the new optional request property

    • info

      added the new files_total enum value to the request property //

    • info

      added the new whatsapp enum value to the request property //

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status