v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Configuração

Modifica a configuração da aplicação

Realiza a modificação dos valores padrão que serão utilizados pela aplicação

put/api/service/config/v1

Request body

showLogoboolean required

Define se a logo será exibida nas telas de assinatura, configuração e e-mails enviados pelo sistema

{"stackTrail":"components:schemas:ClientConfig:properties:logo","oasType":"schema","type":"unknown","description":"Arquivo de imagem que será exibida como logo nas telas utilizadas pela aplicação e nos e-mails enviados pelo sistema. Caso não esteja configurado, será utilizado a logo padrão. O arquivo deve estar no formato PNG/JPEG e possuir tamanho máximo de 1MB. A dimensão ideal da logo é 5x1, valores diferentes podem alterar como ela é exibida."}

Example request

{
  "theme": {
    "primaryColor": "#AABBCC"
  }
}

Response

Retorno com a configuração da aplicação

showLogoboolean required

Define se a logo será exibida nas telas de assinatura, configuração e e-mails enviados pelo sistema

{"stackTrail":"components:schemas:ClientConfig:properties:logo","oasType":"schema","type":"unknown","description":"Arquivo de imagem que será exibida como logo nas telas utilizadas pela aplicação e nos e-mails enviados pelo sistema. Caso não esteja configurado, será utilizado a logo padrão. O arquivo deve estar no formato PNG/JPEG e possuir tamanho máximo de 1MB. A dimensão ideal da logo é 5x1, valores diferentes podem alterar como ela é exibida."}

Example response

{
  "theme": {
    "primaryColor": "#AABBCC"
  }
}