Messenger Platform

Greeting Text

Messenger Profile API

greeting is a property of the Messenger Profile API. For information on retrieving, setting, updating, and deleting greeting, see the Messenger Profile API Reference.

The greeting property of your bot's Messenger profile allows you to specify the greeting message people will see on the welcome screen of your bot. The welcome screen is displayed for people interacting with your bot for the first time.

If greeting text is not set for the user's locale, the standard greeting text set with the thread settings API will be shown in the welcome screen. If the standard greeting text is not set either, the page description will be shown.

Contents

Requirements

To set or update the greeting text you must have the 'Administrator' role for the Page associated with the bot.

greeting Format

"greeting":[
  {
    "locale":"default",
    "text":"Hello!"
  }, {
    "locale":"en_US",
    "text":"Timeless apparel for the masses."
  }
]

Properties

Property Type Description

locale

String

Locale of the greeting text, shown when the person's locale matches the provided locale.


You must at least specify greeting text for the default locale, which will be displayed if no provided locale matches the person's locale.


List of supported locales.

text

String

The greeting text for the specific locale. Must be in UTF-8. 160 character limit.

Personalization

You can personalize the greeting text using the person's name. You can use the following template strings:

  • {{user_first_name}}
  • {{user_last_name}}
  • {{user_full_name}}

Example

"greeting":[
  {
    "locale":"default",
    "text":"Hello {{user_first_name}}!"
  }
]

Rate Limit

Calls to the Messenger Profile API are limited to 10 API calls per 10 minute interval. This rate limit is enforced per Page.