Graph API Version

Page Thread Settings

Reading

Messenger platform configs for the page

Graph API Explorer
GET /v2.10/{page-id}/thread_settings HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{page-id}/thread_settings'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/thread_settings",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/thread_settings",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/thread_settings"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
No data
Page management Apps
  • manage_pages
  • pages_show_list
  • pages_messaging
Other Apps
No data

Parameters

This endpoint doesn't have any parameters.

Fields

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {} }

data

A list of ThreadSetting nodes.

paging

For more details about pagination, see the Graph API guide.

Validation Rules

ErrorDescription
210User not visible

Creating

You can make a POST request to thread_settings edge from the following paths:
When posting to this edge, no Graph object will be created.

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • manage_pages
  • pages_show_list
  • pages_messaging
Page management Apps
  • manage_pages
  • pages_show_list
  • pages_messaging
Other Apps
No data

Parameters

NameDescription
account_linking_url
URL

Account linking URL

call_to_actions
list<Object>

CTAs for null state or structured menu

Supports Emoji
url
URL
title
UTF-8 string
Supports Emoji
type
enum {PHONE_NUMBER, WEB_URL, POSTBACK, ACCOUNT_LINK, ACCOUNT_UNLINK, PIN_PROTECTION, PAGE_SHARE, ELEMENT_SHARE, PAYMENT, NESTED, GAME_PLAY, OPEN_NATIVE}
payload
UTF-8 string
Supports Emoji
webview_height_ratio
enum {COMPACT, TALL, FULL}
webview_share_button
enum {HIDE, SHOW}
messenger_extensions
boolean
domain_action_type
enum {ADD, REMOVE}

Action type for the whitelisted domain setting update. Default to override if not set.

greeting
Object

Greeting text for the nux

text
UTF-8 string
Supports Emoji
payment_dev_mode_action
enum {ADD, REMOVE}

if "ADD", adds users in "payment_testers" in dev mode for payments, these users won't be charged. if "REMOVE", users are taken out of test mode

payment_privacy_url
URL

Payment privacy URL for messenger extensions feature

payment_public_key
string

public key for encrypting discover token and stripe/paypal response

payment_testers
list<numeric string or integer>

Users to be add in dev mode to test payments

setting_type
enum {ACCOUNT_LINKING, CALL_TO_ACTIONS, GREETING, DOMAIN_WHITELISTING, PAYMENT}

Setting type

Required
thread_state
enum {NEW_THREAD, EXISTING_THREAD}

State of thread, new thread or an existing thread

whitelisted_domains
list<URL>

A list of domains allowed for messenger extensions feature or pre-checked plugins

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
result: string,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
105The number of parameters exceeded the maximum for this operation
210User not visible

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.