---
title: "Save the welcome screen"
method: PUT
path: "/v1/connect/welcome-screen"
tags: ["Connect"]
---

# Save the welcome screen

`PUT /v1/connect/welcome-screen`

## Request

- Base URL: `https://zernio.com/api`
- URL: `https://zernio.com/api/v1/connect/welcome-screen`
- Auth: HTTP bearer

Replaces the workspace's welcome screen settings: a field left out is cleared. Only the account owner or a full-access team member can save, and not with a profile-scoped API key. Parameters sent on a connect call still win over these values for that call.

## Request body

- object
  - `showByDefault` boolean, required: Show the welcome screen on connect calls that do not pass `welcome`.
  - `brandName` string
  - `logoUrl` string, uri: https URL of a square logo.
  - `theme` object: Same keys as the `welcomeTheme` parameter of `GET /v1/connect/{platform}`, as a JSON object.

## Response `200`

The saved settings.

- ConnectWelcomeScreen
  - `showByDefault` boolean
  - `brandName` string, nullable
  - `logoUrl` string, nullable
  - `theme` object, nullable: Same keys as the `welcomeTheme` parameter of `GET /v1/connect/{platform}`.

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key. `code` is `missing_credentials` when no Authorization header was sent and `invalid_credentials` when the key is unknown, revoked or expired.
- `403`: The caller cannot change workspace settings (code INSUFFICIENT_PERMISSIONS).

## Changes

- **2026-10-21** `fd4ba69cb07a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zernio/apis/zernio-api/changes/v1/connect/welcome-screen/put.md)

---

[API](https://skmtc.dev/zernio/apis/zernio-api.md) · [All operations](https://skmtc.dev/zernio/apis/zernio-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zernio/apis/zernio-api/revisions/4e74db179e73?raw)