target_audience Reference

Messenger Profile API

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

Target Audience allows you to customize the audience that will see your bot in the Discover tab on Messenger. Other users can still find and use your bot through other channels (e.g. search, m.me URL).

There are three types of Target Audience settings:

  1. Open to all users,
  2. Closed to all users, and
  3. Open or closed to custom set of users.

For more information on the Discover Tab, see Discover Tab.

Contents

Requirements

To set or update the target audience you must have the 'Administrator' role for the Page associated with the app.

target_audience Format

"target_audience":{
  "audience_type":"custom",
  "countries":{
    "whitelist":["US", "CA"]
  }
}

Properties

If audience_type is custom, blacklist and whitelist can't both be null or empty. In addition, only one of them can be non-empty at the same time.

Property Type Description

audience_type

String

Audience type. Valid values include all, custom, or none.

countries

Object

Optional. country object. Needs to be specified only when audience_type is custom.

countries.blacklist

Array<String>

Optional. List of ISO 3166 Alpha-2 codes. Users in any of the blacklist countries won't see your bot on discovery surfaces on Messenger Platform.

countries.whitelist

Array<String>

Optional. List of ISO 3166 Alpha-2 codes. Users in any of the whitelist countries will see your bot on discovery surfaces on Messenger Platform.