API Reference
  1. PlugSign Documentation
  2. Companies (Para revendedores)

POST Update company

post
https://app.plugsign.com.br/api/companies/

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).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

ID da company que deve ser alterada.

Body Params
string
length between 2 and 64

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

file

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

file

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

string
length between 10 and 15

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

string
length between 2 and 64

CNPJ da empresa, formatado ou apenas números.

string
length between 2 and 255

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

string
enum

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

Allowed:
boolean

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

string

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

int32
1 to 7

Tipo de validação padrão ao assinar um documento.

7 - QR Code (Texto) na lateral direita.

6 - QR Code (Texto) na lateral esquerda.

5 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras).

4 - QR Code no rodapé do documento (Sem página final).

3 - Página final de validação e QR Code.

2 - Sem QR Code no topo, apenas página no final.

1 - QR Code no topo do documento (Sem página final).

Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente

boolean

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

limits
array of objects

Limites personalizados da subconta (substituem os valores existentes). Só pode ser enviado por uma conta revendedora principal.

limits
string

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

string

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

boolean
Defaults to false

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.

string
length between 2 and 255

Nome da empresa cadastrada (2 a 255 caracteres).

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?