Messenger Profile API

The Messenger Profile for your Page is where you set properties that define various aspects of the following Messenger Platform features. For more information, see the Messenger Profile Properties table below.

• Get Started Button
• Welcome Page
• Ice Breakers
• Persistent Menu
• Domain Whitelist
• Account Linking
• Commands
• Discover Tab (Deprecated)

The Messenger Profile API allows you to set, update, retrieve, and delete properties from the Page Messenger Profile.

Permissions

A page access token with pages_messaging permission is required to interact with this endpoint.

Apps in Development Mode, the Messenger Profile settings will only be visible to people with role on the app.

Request URI

https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>

Messenger Profile Properties

The following properties may be included in the Messenger profile for your Page. See descriptions in the table below for the type and purpose of each property.

Retrieve Properties

Retrieves the current value of one or more Messenger Profile properties by name.

Request Parameters

The following parameters are included in the query string of the request:

Example Request

curl -X GET "https://graph.facebook.com/v21.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

Example Response

The current value of the requested properties will be returned in the data array:

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

Set/Update Properties

Sets the values of one or more Messenger Profile properties. Only properties set in the request body will be overwritten.

Example Request

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Example Response

{
    "result": "success"
}

Delete Properties

Deletes one or more Messenger Profile properties. Only properties specified in the fields array will be deleted.

Example Request

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

Example Response

{
    "result": "success"
}