Connect

Save the welcome screen

Changed on

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.

put/v1/connect/welcome-screen

Request

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

Request body

showByDefaultboolean required

Show the welcome screen on connect calls that do not pass welcome.

brandNamestring
logoUrlstring uri

https URL of a square logo.

themeobject

Same keys as the welcomeTheme parameter of GET /v1/connect/{platform}, as a JSON object.

Response

The saved settings.

showByDefaultboolean
brandNamestring nullable
logoUrlstring nullable
themeobject nullable

Same keys as the welcomeTheme parameter of GET /v1/connect/{platform}.

Example response

{
  "showByDefault": true,
  "brandName": "Acme",
  "logoUrl": "https://acme.com/logo.png",
  "theme": {
    "primaryColor": "#1D4ED8",
    "cornerRadius": 12
  }
}

Changes