v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Update company

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.

post/api/companies/{id}

Path parameters

idinteger required

ID da company que deve ser alterada.

Request body

namestring

Nome da empresa cadastrada.

company_brandstring binary

Logo da empresa.

company_iconstring binary

Ícone da empresa.

phonestring

Telefone da empresa, somente números com DDD, caso seja um celular com WhatsApp, o mesmo será utilizado nas comunicações.

cnpjstring

CNPJ da empresa devidamente formatado ou apenas números.

addressstring

Endereço da empresa.

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

Status do usuario.

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

Formato d/m/Y.

editablevalidateinteger

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

unlimitedinteger

Quando ativado (True), nenhum custom limit será aplicado a empresa.

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.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

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