# Welcome board card

> Canonical HTML: https://screenrig.ai/docs/cards/welcome/

A lobby welcome: a time-of-day greeting and today's named visitors with their companies, set with a spotlight that moves down the list.

Category: People. Tags: Lobbies and reception, Offices and workplaces, Recognition.

## Previews

![Welcome board](/cards/welcome/v1/screenshots/canvas-bloom.webp?sha=e626b0a9fd403f027d9de8dfbe6735647c19c86e9c86952663411acee5f42eb7)

Canvas

![Welcome board](/cards/welcome/v1/screenshots/corner-bloom.webp?sha=6f83f97d380ac8b687e416fb3a6bcece9a6c1cfc4467b340953e28c2525d1c54)

Corner

![Welcome board](/cards/welcome/v1/screenshots/chip-bloom.webp?sha=b181a092ef1d0da72f9f90369aba477cc7fa24c122f4c9cf2248118d6ad18943)

Chip

## Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.

[Card views, themes and publishing](/docs/cards/). [Browse the gallery](/apps/#cards).

## Data and privacy

This card uses its configured properties and live card data.

## Properties

For theme, background, accent and position, see [Common properties](/docs/cards/#common-properties).

Set static properties in `params`. Bind `data` to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in `params`. Nested rows describe the contents of their parent property.

### Static properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `title` | string | `"Today's guests"` | maxLength: `40` |  |
| `greeting` | string | `""` | maxLength: `40` | The big words. Empty greets by the time of day: Good morning, Good afternoon or Good evening. |
| `organization` | string | `""` | maxLength: `60` | Your name; reads "Welcome to <organization>" above the greeting. Empty hides the line. |
| `order` | string | `"listed"` | `"listed"`, `"time"`, `"name"` | listed: as given. time: earliest first, untimed last. name: A to Z. |
| `showDate` | boolean | `true` |  |  |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `visitors` | array | `[]` | minItems: `0`; maxItems: `40` |  |
| `visitors[].name` | string |  | minLength: `1`; maxLength: `60`; Required |  |
| `visitors[].company` | string | `""` | maxLength: `60` |  |
| `visitors[].note` | string | `""` | maxLength: `60` | After the company: who they are meeting, or a room. |
| `visitors[].time` | string | `""` | maxLength: `12` | When they are expected, as written ("9:30 AM", "14:00"). It also orders the list when order is time. |
| `footnote` | string | `""` | maxLength: `120` |  |

## Canvas example

Add this item to a playlist page’s `primitives`. [Publish the playlist and assign a screen](/docs/cards/#publish-a-card-canvas).

```json
{
  "id": "welcome",
  "primitive": "card",
  "card": "welcome",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "welcome-main"
}
```

## Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see [API authentication](/docs/authentication/).

```console
curl --request PUT "https://api.screenrig.ai/api/card-data/welcome-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"visitors":[],"footnote":""}}'
```