v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Application Settings

Create or update application setting

Creates or updates a configuration setting for an application. Settings can include favicon, primary color, journey alias, identity provider, and enrollment button visibility. This allows customization of the application's appearance and behavior.

post/baas/v1/open/itp/applications/{applicationId}/settings

Path parameters

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

Request body

key'FAVICON' | 'PRIMARY_COLOR' | 'JOURNEY_DEFAULT_ALIAS' | 'IDENTITY_PROVIDER' | 'DISABLE_ENROLLMENT_BUTTON' required

		Tipos de chaves usadas para a customização da aplicação.

		- FAVICON: Url para carregar o Favicon.
		- PRIMARY_COLOR: Cor primária da aplicação usada na whitelabel.
		- JOURNEY_DEFAULT_ALIAS: Alias de Jornada default da aplicação
		- IDENTITY_PROVIDER: Provedor de identidade usada na whitelabel de gestão do usúario final

valuestring required

Valor para personalização

Example request

{
  "key": "FAVICON"
}

Response

successfully returned.

idstring required

O ID das configurações da aplicação.

createdAtstring required

updatedAtstring required

deletedAtstring required

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

key'FAVICON' | 'PRIMARY_COLOR' | 'JOURNEY_DEFAULT_ALIAS' | 'IDENTITY_PROVIDER' | 'DISABLE_ENROLLMENT_BUTTON' required

		Tipos de chaves usadas para a customização da aplicação.

		- FAVICON: Url para carregar o Favicon.
		- PRIMARY_COLOR: Cor primária da aplicação usada na whitelabel.
		- JOURNEY_DEFAULT_ALIAS: Alias de Jornada default da aplicação
		- IDENTITY_PROVIDER: Provedor de identidade usada na whitelabel de gestão do usúario final

valuestring required

Valor para personalização

Example response

{
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "key": "FAVICON"
}