# Greeting card

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

The coming occasion's greeting and sign-off over a themed scene of snow, confetti, lanterns, leaves, fireworks, hearts, petals or stars.

Category: Events. Tags: Lobbies and reception, Stores, News and announcements, Events and venues.

## Previews

![Greeting](/cards/greeting/v1/screenshots/canvas-bloom.webp?sha=b5b805c191430b8ff91bdb8498d40bfaa416484c22aeaa3dc7d67cb68f293d6f)

Canvas

![Greeting](/cards/greeting/v1/screenshots/corner-bloom.webp?sha=238d06bac0097ff41a42ee4cf565fbe2698647f2271863d749695dc29408e0a2)

Corner

![Greeting](/cards/greeting/v1/screenshots/chip-bloom.webp?sha=c817c6d3e85a57d96d05c34f8ad1636c735dd210a714ffe352c38739034a73d5)

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 |
| --- | --- | --- | --- | --- |
| `calendars` | array | `["world"]` | maxItems: `11`; uniqueItems: `true` | Which sets of occasions the card draws from: world (New Year, Valentine's Day, Easter, Halloween, Christmas), christian, orthodox, us, canada, uk, australia, lunar, jewish, islamic and south-asian. |
| `occasion` | string | `"auto"` | `"auto"`, `"new-years-day"`, `"valentines-day"`, `"st-patricks-day"`, `"easter"`, `"earth-day"`, `"halloween"`, `"christmas-eve"`, `"christmas"`, `"new-years-eve"`, `"good-friday"`, `"orthodox-christmas"`, `"orthodox-easter"`, `"mlk-day"`, `"presidents-day"`, `"mothers-day"`, `"memorial-day"`, `"juneteenth"`, `"fathers-day"`, `"independence-day"`, `"labor-day"`, `"veterans-day"`, `"thanksgiving"`, `"canada-day"`, `"victoria-day"`, `"thanksgiving-ca"`, `"remembrance-day"`, `"boxing-day"`, `"mothering-sunday"`, `"bonfire-night"`, `"remembrance-sunday"`, `"australia-day"`, `"anzac-day"`, `"fathers-day-au"`, `"lunar-new-year"`, `"lantern-festival"`, `"dragon-boat"`, `"mid-autumn"`, `"rosh-hashanah"`, `"passover"`, `"hanukkah"`, `"ramadan"`, `"eid-al-fitr"`, `"eid-al-adha"`, `"islamic-new-year"`, `"diwali"`, `"vaisakhi"` | auto picks the occasion in season, or the next one. An id shows that occasion's greeting on every day. |
| `showUpcoming` | boolean | `true` |  | When nothing is in season, show the next occasion with its countdown. Off shows the plain message. |
| `leadDays` | integer, null | `null` | minimum: `0`; maximum: `60` | How many days before an occasion its greeting appears. Empty uses each occasion's own lead-in. |
| `moonOffset` | integer | `0` | minimum: `-2`; maximum: `2` | Days added to Ramadan and Eid dates, to follow a local moon sighting. |
| `timeZone` | string, null | `null` |  |  |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `message` | string | `""` | maxLength: `120` | Replaces the occasion's greeting. With no occasion in view it is the card's message (Welcome when empty). |
| `note` | string | `""` | maxLength: `160` | Replaces the line under the greeting. |
| `signoff` | string | `""` | maxLength: `100` | Replaces the sign-off (With warm wishes). |

## 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": "greeting",
  "primitive": "card",
  "card": "greeting",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "greeting-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/greeting-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"message":"","note":"","signoff":""}}'
```