POST Create company

post

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

Com este endpoint, você pode criar uma subconta e, a partir disso, manipular a conta utilizando o seu respectivo token.

Esse processo permite que você gerencie subcontas de forma independente dentro do sistema.

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

Regras:

company_brand e company_icon são imagens (PNG ou JPG) e exigem multipart/form-data; quando omitidas, a subconta herda a logo e o ícone da revendedora.
email precisa ser único entre empresas e usuários da plataforma.
Sem password, a plataforma gera uma senha e a envia por e-mail ao administrador; com password, nenhum e-mail é enviado.
Padrões: can_login = 1, editablevalidate = 1, unlimited = 0. O administrador é criado com status Active.
A subconta recebe um token de API de 337 caracteres (campo token da resposta e company.access.token), vinculado à sua revendedora.
limits só pode ser enviado por uma conta revendedora principal; uma subconta que tenta definir limites recebe 403.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 100

Primeiro nome do administrador da empresa (até 100 caracteres).

last_name

string

required

Sobrenome do administrador da empresa.

company_name

string

required

length between 2 and 255

Nome da empresa cadastrada (2 a 255 caracteres).

string

required

E-mail da empresa e do administrador da conta. Precisa ser único entre empresas e usuários da plataforma. O e-mail da empresa pode ser alterado depois; o do administrador não.

phone

string

required

length between 10 and 15

Telefone da empresa, somente números com DDD (10 a 15 caracteres). Se for um celular com WhatsApp, será usado para notificações.

company_brand

file

Logo da empresa (imagem PNG ou JPG, multipart/form-data). Se omitida, herda a logo da revendedora.

company_icon

file

Ícone da empresa (imagem PNG ou JPG, multipart/form-data). Se omitido, herda o ícone da revendedora.

cnpj

string

required

CNPJ da empresa devidamente formatado ou apenas números.

address

string

required

Endereço da empresa.

password

string

Senha de acesso do administrador. Se omitida, a plataforma gera uma senha e a envia por e-mail; se informada, nenhum e-mail é enviado.

recive_whatsapp

integer

enum

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

Allowed:

recive_email

integer

enum

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

Allowed:

mail_host

string

Host do seu provedor de e-mails.

mail_from

string

Qual endereço de e-mail está enviando a mensagem.

mail_username

string

Usuário de e-mail para autenticação (Na maioria dos casos é o mesmo do mail_from).

mail_password

string

Senha do e-mail.

mail_encryption

string

Tipo de criptografia do SMTP. Valores aceitos: ssl ou tsl (use tsl para STARTTLS).

mail_port

int32

Porta de saída do provedor, somente números.

can_login

boolean

Defaults to true

true/1 se a empresa está autorizada a acessar a plataforma, false/0 se não. Padrão: 1.

payment_end

string

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

plugzapi_instance

string

Instância do PlugZapi.

plugzapi_token

string

Token do PlugZapi.

plugzapi_account_token

string

Account token do PlugZapi.

editablevalidate

int32

1 to 7

Defaults to 1

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.

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

3 - 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).

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

6 - QR Code (Texto) na lateral esquerda.

7 - QR Code (Texto) na lateral direita.

unlimited

boolean

Defaults to false

Quando true/1, nenhum limite personalizado é aplicado à subconta. Padrão: 0.

limits

array of objects

Limites personalizados da subconta. Só pode ser enviado por uma conta revendedora principal (subcontas recebem 403).

limits

webhook_header_name

string

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

webhook_header_value

string

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

reseller_login

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.

Responses

200200

403Subconta tentando definir limites

422Erro de validação

501Conta sem perfil de revendedora