Skip to main content
POST
Update greeting
Required scopes: greetings:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
id
integer
required

The ID of the greeting to update.

type
enum<string>

The greeting type.

  • normal — displayed on every visit.
  • announcement — displayed once per visitor.
Available options:
normal,
announcement
active
boolean

The greeting status. If set to true: the greeting is active.

active_from
string<date-time>

The RFC 3339 date-time format indicating when the greeting becomes active.

active_until
string<date-time>

The RFC 3339 date-time format indicating when the greeting stops being active.

name
string

The greeting name.

rules
object[]

An array of action rules. See Create Greeting for detailed structure and validation.

Maximum array length: 10
properties
object

The additional properties. See Create Greeting for allowed keys.

rich_message
object

The rich message content. See Create Greeting for complete structure.

Response

200

Greeting updated successfully.