Graph API Version

Page

Represents a Page. Refer to our Pages documentation for additional usage information. To manage a child Page's location use the /{page-id}/locations edge.

Reading

Feature Permissions

NameDescription
Page Public Content AccessThis feature permission may be required.

Get fields and edges on a Page.

Requirements

Requirements vary based on the Page's status (published, unpublished) any visibility restrictions (restricted, unrestricted), such as age-based or demographic-based restrictions. Note that for restricted Pages, the app user must also satisfy any restrictions in order for data to be returned.

TypePublished and UnrestrictedPublished and RestrictedUnpublished

Access Tokens

App or User

User or Page


A Page access token is required for any fields that may include User information.

Page

Features

Page Public Content Access if you lack the manage_pages permission

Page Public Content Access if you lack the manage_pages permission

None

Permissions

manage_pages if you lack the Page Public Content Access feature

manage_pages if you lack the Page Public Content Access feature

None

Page Tasks

None

None

Admin role equivalent

Example

Graph API Explorer
GET /v5.0/{page-id}/locations?fields=location%7Blatitude%2Clongitude%7D%2Cis_permanently_closed&limit=30000 HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{page-id}/locations?fields=location%7Blatitude%2Clongitude%7D%2Cis_permanently_closed&limit=30000',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/locations",
    {
        "fields": "location{latitude,longitude},is_permanently_closed",
        "limit": "30000"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
Bundle params = new Bundle();
params.putString("fields", "location{latitude,longitude},is_permanently_closed");
params.putString("limit", "30000");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/locations",
    params,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"fields": @"location{latitude,longitude},is_permanently_closed",
  @"limit": @"30000",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/locations"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
curl -X GET \
  -d 'fields="location{latitude,longitude},is_permanently_closed"' \
  -d 'limit=30000' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v5.0/{page-id}/locations
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
account_linking_token
UTF-8 encoded string

Short lived account linking token (5 mins expiry) to get the PSID for a user-page pair

Fields

FieldDescription
id
numeric string

Page ID. No access token is required to access this field

about
string

Information about the Page

access_token
string

The Page's access token. Only returned if the User making the request has a role (other than Live Contributor) on the Page. If your business requires two-factor authentication, the User must also be authenticated

ad_campaign

The Page's currently running promotion campaign

affiliation
string

Affiliation of this person. Applicable to Pages representing people

app_id
id

App ID for app-owned Pages and app Pages

app_links

AppLinks data associated with the Page's URL

artists_we_like
string

Artists the band likes. Applicable to Bands

attire
string

Dress code of the business. Applicable to Restaurants or Nightlife. Can be one of Casual, Dressy or Unspecified

awards
string

The awards information of the film. Applicable to Films

band_interests
string

Band interests. Applicable to Bands

band_members
string

Members of the band. Applicable to Bands

best_page

The best available Page on Facebook for the concept represented by this Page. The best available Page takes into account authenticity and the number of likes

bio
string

Biography of the band. Applicable to Bands

birthday
string

Birthday of this person. Applicable to Pages representing people

booking_agent
string

Booking agent of the band. Applicable to Bands

built
string

Year vehicle was built. Applicable to Vehicles

business

The Business associated with this Page. Requires business_management permissions, and a page or user access token. The person requesting the access token must be an admin of the page.

can_checkin
bool

Whether this page has checkin functionality enabled

can_post
bool

Whether the current session user can post on this Page

category
string

The Page's category. e.g. Product/Service, Computers/Technology

category_list

The Page's sub-categories

company_overview
string

The company overview. Applicable to Companies

connected_instagram_account
IGUser

Instagram account connected to page via page settings

contact_address

The mailing or contact address for this page. This field will be blank if the contact address is the same as the physical address

copyright_attribution_insights
CopyrightAttributionInsights

Insight metrics that measures performance of copyright attribution. An example metric would be number of incremental followers from attribution

copyright_whitelisted_ig_partners
list<string>

Whitelisted Instagram usernames that will not be reported in copyright match systems

country_page_likes
unsigned int32

If this is a Page in a Global Pages hierarchy, the number of people who are being directed to this Page

cover

Information about the page's cover photo

culinary_team
string

Culinary team of the business. Applicable to Restaurants or Nightlife

current_location
string

Current location of the Page

description
string

The description of the Page

description_html
string

The description of the Page in raw HTML

directed_by
string

The director of the film. Applicable to Films

display_subtext
string

Subtext about the Page being viewed

displayed_message_response_time
string

Page estimated message response time displayed to user

emails
list<string>

The emails listed in the About section of a Page

engagement

The social sentence and like count information for this Page. This is the same info used for the like button

fan_count
unsigned int32

The number of users who like the Page. For Global Pages this is the count for all Pages across the brand

featured_video

Video featured by the Page

features
string

Features of the vehicle. Applicable to Vehicles

food_styles
list<string>

The restaurant's food styles. Applicable to Restaurants

founded
string

When the company was founded. Applicable to Pages in the Company category

general_info
string

General information provided by the Page

general_manager
string

General manager of the business. Applicable to Restaurants or Nightlife

genre
string

The genre of the film. Applicable to Films

global_brand_page_name
string

The name of the Page with country codes appended for Global Pages. Only visible to the Page admin

global_brand_root_id
numeric string

This brand's global Root ID

has_added_app
bool

Indicates whether this Page has added the app making the query in a Page tab

has_whatsapp_business_number
bool

Indicates whether WhatsApp number connected to this page is a WhatsApp business number

has_whatsapp_number
bool

SELF_EXPLANATORY

hometown
string

Hometown of the band. Applicable to Bands

hours
map<string, string>

Indicates a single range of opening hours for a day. Each day can have 2 different hours ranges. The keys in the map are in the form of {day}_{number}_{status}. {day} should be the first 3 characters of the day of the week, {number} should be either 1 or 2 to allow for the two different hours ranges per day. {status} should be either open or close to delineate the start or end of a time range. An example would be mon_1_open with value 17:00 and mon_1_close with value 21:15 which would represent a single opening range of 5pm to 9:15pm on Mondays. If one specific day is open 24 hours, the range should be specified as 00:00 to 24:00. If the place is open 24/7, is_always_open field should be set directly

impressum
string

Legal information about the Page publishers

influences
string

Influences on the band. Applicable to Bands

instagram_business_account
IGUser

Instagram account linked to page during Instagram business conversion flow

instant_articles_review_status
enum

Indicates the current Instant Articles review status for this page

is_always_open
bool

Indicates whether this location is always open

is_chain
bool

Indicates whether location is part of a chain

is_community_page
bool

Indicates whether the Page is a community Page

is_eligible_for_branded_content
bool

Indicates whether the page is eligible for the branded content tool

is_messenger_bot_get_started_enabled
bool

Indicates whether the page is a Messenger Platform Bot with Get Started button enabled

is_messenger_platform_bot
bool

Indicates whether the page is a Messenger Platform Bot

is_owned
bool

Indicates whether page is owned

is_permanently_closed
bool

Whether the business corresponding to this Page is permanently closed

is_published
bool

Indicates whether the Page is published and visible to non-admins

is_unclaimed
bool

Indicates whether the Page is unclaimed

is_verified
bool

Deprecated, use "verification_status". Pages with a large number of followers can be manually verified by Facebook as [having an authentic identity] (https://www.facebook.com/help/196050490547892). This field indicates whether the page is verified by this process

Deprecated
is_webhooks_subscribed
bool

Indicates whether the application is subscribed for real time updates from this page

keywords
null

Deprecated. Returns null

Deprecated
leadgen_form_preview_details
LeadGenFormPreviewDetails

The details needed to generate an accurate preview of a lead gen form

leadgen_tos_acceptance_time
datetime

Indicates the time when the TOS for running LeadGen Ads on the page was accepted

leadgen_tos_accepted
bool

Indicates whether a user has accepted the TOS for running LeadGen Ads on the Page

leadgen_tos_accepting_user

Indicates the user who accepted the TOS for running LeadGen Ads on the page

link
string

The Page's Facebook URL

location

The location of this place. Applicable to all Places

merchant_id
string

The instant workflow merchant id associated with the Page

merchant_review_status
enum

Review status of the Page against FB commerce policies, this status decides whether the Page can use component flow

messenger_ads_default_icebreakers
list<string>

The default ice breakers for a certain page

messenger_ads_default_quick_replies
list<string>

The default quick replies for a certain page

messenger_ads_quick_replies_type
enum

Indicates what type this page is and we will generate different sets of quick replies based on it

mission
string

The company mission. Applicable to Companies

mpg
string

MPG of the vehicle. Applicable to Vehicles

name
string

The name of the Page

name_with_location_descriptor
string

The name of the Page with its location and/or global brand descriptor. Only visible to a page admin. Non-page admins will get the same value as name.

network
string

The TV network for the TV show. Applicable to TV Shows

new_like_count
unsigned int32

The number of people who have liked the Page, since the last login. Only visible to a page admin

offer_eligible
bool

Offer eligibility status. Only visible to a page admin

overall_star_rating
float

Overall page rating based on rating survey from users on a scale of 1-5. This value is normalized and is not guaranteed to be a strict average of user ratings. If there are 0 or a small number of ratings, this field will not be returned.

page_about_story
PageAboutStory

A Page About Story is a document located in your Page's About section. It tells your Page's story with rich text and images and can be updated as your story evolves

page_token
string

SELF_EXPLANATORY

parent_page

Parent Page of this Page. If the Page is part of a Global Root Structure and you have permission to the Global Root, the Global Root Parent Page is returned. If you do not have Global Root permission, the Market Page for your current region is returned as the Parent Page. If your Page is not part of a Global Root Structure, the Parent Page is returned.

parking

Parking information. Applicable to Businesses and Places

payment_options

Payment options accepted by the business. Applicable to Restaurants or Nightlife

personal_info
string

Personal information. Applicable to Pages representing People

personal_interests
string

Personal interests. Applicable to Pages representing People

pharma_safety_info
string

Pharmacy safety information. Applicable to Pharmaceutical companies

phone
string

Phone number provided by a Page

place_type
enum

For places, the category of the place

plot_outline
string

The plot outline of the film. Applicable to Films

preferred_audience
Targeting

Group of tags describing the preferred audienceof ads created for the Page

press_contact
string

Press contact information of the band. Applicable to Bands

price_range
string

Price range of the business, such as a restaurant or salon. Values can be one of $, $$, $$$, $$$$, Not Applicable, or null if no value is set.

privacy_info_url
string

Privacy url in page info section

produced_by
string

The productor of the film. Applicable to Films

products
string

The products of this company. Applicable to Companies

promotion_eligible
bool

Boosted posts eligibility status. Only visible to a page admin

promotion_ineligible_reason
string

Reason for which boosted posts are not eligible. Only visible to a page admin

public_transit
string

Public transit to the business. Applicable to Restaurants or Nightlife

rating_count
unsigned int32

Number of ratings for the page (limited to ratings that are publicly accessible)

recipient
numeric string

Messenger page scope id associated with page and a user using account_linking_token

record_label
string

Record label of the band. Applicable to Bands

release_date
string

The film's release date. Applicable to Films

restaurant_services

Services the restaurant provides. Applicable to Restaurants

restaurant_specialties

The restaurant's specialties. Applicable to Restaurants

schedule
string

The air schedule of the TV show. Applicable to TV Shows

screenplay_by
string

The screenwriter of the film. Applicable to Films

season
string

The season information of the TV Show. Applicable to TV Shows

single_line_address
string

The page address, if any, in a simple single line format.

starring
string

The cast of the film. Applicable to Films

start_info

Information about when the entity represented by the Page was started

store_code
string

Unique store code for this location Page

store_location_descriptor
string

Location Page's store location descriptor

store_number
unsigned int32

Unique store number for this location Page

studio
string

The studio for the film production. Applicable to Films

supports_instant_articles
bool

Indicates whether this Page supports Instant Articles

talking_about_count
unsigned int32

The number of people talking about this Page

unread_message_count
unsigned int32

Unread message count for the Page. Only visible to a page admin

unread_notif_count
unsigned int32

Number of unread notifications. Only visible to a page admin

unseen_message_count
unsigned int32

Unseen message count for the Page. Only visible to a page admin

username
string

The alias of the Page. For example, for www.facebook.com/platform the username is 'platform'

verification_status
string

Showing whether this Page is verified and in what color e.g. blue verified, gray verified or not verified

voip_info

Voip info

website
string

The URL of the Page's website

were_here_count
unsigned int32

The number of visits to this Page's location. If the Page setting Show map, check-ins and star ratings on the Page (under Page Settings > Page Info > Address) is disabled, then this value will also be disabled

whatsapp_number
string

SELF_EXPLANATORY

written_by
string

The writer of the TV show. Applicable to TV Shows

Edges

EdgeDescription

The ad posts for this Page

Businesses that have agency permissions on the Page

Photo albums for this Page

Users assigned to this page

The music copyrights owned by this page (using alacorn)

User or Page Profiles blocked from this Page

The canvas elements associated with this page

The canvas documents associated with this page

Claimed URLs for Instant Articles that are associated with this Facebook Page

This Page's conversations

Whitelisted pages and users that will not be reported in the copyright match systems

Pages whitelisted for crossposting

Custom user settings for a page

Returns the Events on a Page.

Featured Videos for this Page

This Page's wall

Children Pages of a Global Pages root Page. Both default and root Page can return children Pages

This Page's Insights data

List of all insights reports from a Page

Linked Instagram accounts for this Page

Instant articles associated with this Page

Instant article insights aggregated over all instant articles for that page

A library of lead generation forms created for this page.

The Pages that this Page has liked

Live encoders owned by this Page

Live videos from this page

The location Pages that are children of this Page

Media fingerprints from this page

string

Members of this org. Applicable to Pages representing Team Orgs

Feature status of the page that has been granted through feature review that show up in the page settings

SELF_EXPLANATORY

The native offers created by this Page

Edge

This Page's notes

Edge

Notifications for this Page

Gets the Page Backed Instagram Account (an InstagramUser) associated with this Page.

Messenger Platform Bot personas for the Page

This Page's photos

This Page's profile picture

The place topic associated with the categories of the page

This Page's own posts, a derivative of /feed

Product catalogs owned by this page

All published posts by this page

Edge

The Page's questions

The Page's Admins

All posts that are scheduled to a future date by a page

Secondary Receivers for a page

Controllable settings for this page

Playlists for this show page

Applications that have real time update subscriptions for this Page. Note that we will only return information about the current app

The photos, videos, and posts in which the Page has been tagged. A derivative of /feeds

App which owns a thread for Handover Protocol

Deprecated. Use conversations instead

tours

Video copyright rules from this page

Video copyrights from this page

Video Playlists for this Page

Video copyrights from this page using alacorn

Videos for this Page

Shows all public posts published by page visitors on the page

Validation Rules

ErrorDescription
100Invalid parameter
80001There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
200Permissions error
110Invalid user id
80002There have been too many calls to this Instagram account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
210User not visible
80006There have been too many messenger api calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
283That action requires the extended permission manage_pages
190Invalid OAuth 2.0 Access Token
159Invalid protocol, must be https

Creating

To create a Page using the Pages API, your app must be whitelisted. Contact your Facebook representative to apply for this feature.

You can make a POST request to client_pages edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

ParameterDescription
page_id
Page ID

Page ID.

Required
permitted_tasks
array<enum {MANAGE, CREATE_CONTENT, MODERATE, ADVERTISE, ANALYZE, MODERATE_COMMUNITY, MANAGE_JOBS, PAGES_MESSAGING, PAGES_MESSAGING_SUBSCRIPTIONS, READ_PAGE_MAILBOXES, VIEW_MONETIZATION_INSIGHTS, MANAGE_LEADS, PLATFORM_MANAGE_PAGES, PLATFORM_READ_INSIGHTS, PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES}>

Permitted tasks on the page, such as ADVERTISE.

Return Type

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

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter
3946Asset already belongs to this Business Manager.
3988You do not have permission to request access to the given object.
3945This Business Manager has a pending ownership request to this object. Please cancel or decline it to continue.
You can make a POST request to owned_pages edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

ParameterDescription
page_id
Page ID

Page ID.

Required

Return Type

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

Validation Rules

ErrorDescription
413Invalid password
3977To claim a Page in Business Manager, you must already be an Admin of the Page.
200Permissions error
3982You do not have sufficient permissions to import this asset into the given Business Manager.
3944Your Business Manager already has access to this object.
100Invalid parameter
3948Please assign someone as a manager to this Page before removing it from your Business Manager.
You can make a POST request to subscribed_apps edge from the following paths:
When posting to this edge, a Page will be created.

Example

Graph API Explorer
POST /v5.0/{page-id}/subscribed_apps HTTP/1.1
Host: graph.facebook.com

subscribed_fields=leadgen
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/{page-id}/subscribed_apps',
    array (
      'subscribed_fields' => 'leadgen',
    ),
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/subscribed_apps",
    "POST",
    {
        "subscribed_fields": "leadgen"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
Bundle params = new Bundle();
params.putString("subscribed_fields", "leadgen");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/subscribed_apps",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
NSDictionary *params = @{
  @"subscribed_fields": @"leadgen",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/subscribed_apps"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
curl -X POST \
  -F 'subscribed_fields="leadgen"' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v5.0/{page-id}/subscribed_apps
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
subscribed_fields
array<enum {feed, mention, name, picture, category, description, conversations, branded_camera, feature_access_list, standby, message_mention, messages, message_reactions, messaging_account_linking, messaging_checkout_updates, message_echoes, message_deliveries, messaging_game_plays, messaging_optins, messaging_optouts, messaging_payments, messaging_postbacks, messaging_pre_checkouts, message_reads, messaging_referrals, messaging_handovers, messaging_policy_enforcement, messaging_page_feedback, messaging_appointments, messaging_direct_sends, founded, company_overview, mission, products, general_info, leadgen, leadgen_fat, location, hours, parking, public_transit, page_about_story, commerce_order, mcom_invoice_change, invoice_access_invoice_change, phone, email, website, ratings, attire, payment_options, culinary_team, general_manager, price_range, awards, hometown, current_location, bio, affiliation, birthday, personal_info, personal_interests, publisher_subscriptions, members, checkins, page_upcoming_change, page_change_proposal, merchant_review, product_review, videos, live_videos, video_text_question_responses, registration}>

Page Webhooks fields that you want to subscribe

Required

Return Type

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

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
80001There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
210User not visible
You can make a POST request to personas edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

ParameterDescription
name
string

Name of a Persona

Required
profile_picture_url
URI

Profile picture of a Persona

Required

Return Type

Struct {
id: numeric string,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
You can make a POST request to nlp_configs edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

ParameterDescription
custom_token
string

An optional wit token enable custom entities

model
enum {ARABIC, CHINESE, CROATIAN, CUSTOM, DANISH, DUTCH, ENGLISH, FRENCH_STANDARD, GEORGIAN, GERMAN_STANDARD, GREEK, HEBREW, HUNGARIAN, IRISH, ITALIAN_STANDARD, KOREAN, NORWEGIAN_BOKMAL, POLISH, PORTUGUESE, ROMANIAN, SPANISH, SWEDISH, VIETNAMESE}

an option for which model to use in production, i.e en, fr, custom

n_best
int64

the number of trait entities to return, other than the best one

nlp_enabled
boolean

A boolean to decide wheather nlp is enabled or not

other_language_support
JSON object {string : JSON object}

A map of language to model type and wit token for language identification

verbose
boolean

whether to show more information per entity

Return Type

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

Validation Rules

ErrorDescription
100Invalid parameter
You can make a POST request to page_about_story edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

ParameterDescription
composed_text
array<JSON object>

composed_text

cover_photo
JSON object {string : int64}

cover_photo

entity_map
array<JSON object>

entity_map

is_published
boolean

is_published

title
string
Default value: ""

SELF_EXPLANATORY

Return Type

This endpoint supports read-after-write and will read the node represented by page_about_story_id in the return type.
Struct {
page_about_story_id: numeric string,
}

Validation Rules

ErrorDescription
200Permissions error
54001There is an existing story under this page, you can't create a new one. Please update the existing story or delete it before create a new one.
You can make a POST request to leadgen_forms edge from the following paths:
When posting to this edge, a Page will be created.

Parameters

ParameterDescription
allow_organic_lead_retrieval
boolean
Default value: true

Previously, this flag controlled whether any leads submitted in a non-Ad context were retrievable. Now this flag will not be considered and it will be deprecated entirely. To control visibility of Lead Forms in a non-Ad context you should use 'block_display_for_non_targeted_viewer'

block_display_for_non_targeted_viewer
boolean

Whether to make the organic post invisible to viewers in non-Ad context

context_card
Object

Optional context card shown as the intro page

Supports Emoji
title
string

style
enum {LIST_STYLE, PARAGRAPH_STYLE}

content
list<string>

button_text
string

cover_photo_id
photo ID

cover_photo
file

Custom cover photo for context card

custom_disclaimer
Object

Customized disclaimer including title, body content with inline links, and consent checkboxes

title
string

body
Object

text
string

Required
url_entities
list<JSON object>

offset
int64

Required
length
int64

Required
url
string

Required
checkboxes
list<Object>

is_required
boolean
Default value: true

is_checked_by_default
boolean
Default value: false

text
string

Required
key
string

follow_up_action_url
URI

The final destination URL that user will go to when clicking view website button

is_for_canvas
boolean
Default value: false

Flag to indicate that the form is going to be used under a canvas

is_optimized_for_quality
boolean
Default value: false

Flag to indicate whether the form will be optimized for quality

locale
enum {EN_US, IT_IT, FR_FR, ES_ES, ES_LA, DE_DE, EN_GB, PT_BR, ZH_TW, ZH_HK, TR_TR, AR_AR, CS_CZ, DA_DK, FI_FI, HE_IL, HI_IN, HU_HU, ID_ID, JA_JP, KO_KR, NB_NO, NL_NL, PL_PL, PT_PT, RO_RO, RU_RU, SV_SE, TH_TH, VI_VN, ZH_CN}

The locale of the form. Pre-defined questions renders in this locale

name
string

The name that will help identity the form

Required
privacy_policy
Object

The url and link_text of the privacy policy of advertiser

url
string

link_text
string

question_page_custom_headline
string

The custom headline for the question page within the form

questions
list<Object>

An array of questions of the form

Required
key
string

label
string

type
enum {CUSTOM, CITY, COMPANY_NAME, COUNTRY, DOB, EMAIL, GENDER, FIRST_NAME, FULL_NAME, JOB_TITLE, LAST_NAME, MARITIAL_STATUS, PHONE, POST_CODE, PROVINCE, RELATIONSHIP_STATUS, STATE, STREET_ADDRESS, ZIP, WORK_EMAIL, MILITARY_STATUS, WORK_PHONE_NUMBER, STORE_LOOKUP, STORE_LOOKUP_WITH_TYPEAHEAD, DATE_TIME, ID_CPF, ID_AR_DNI, ID_CL_RUT, ID_CO_CC, ID_EC_CI, ID_PE_DNI, ID_MX_RFC}

Required
inline_context
string

options
list<JSON object>

key
string

value
string

Required
dependent_conditional_questions
list<JSON object>

name
string

Required
field_key
string

Required
input_type
enum {TEXT, INLINE_SELECT, SELECT, MESSENGER_CHECKBOX, CONDITIONAL_ANSWER, STORE_LOOKUP, STORE_LOOKUP_WITH_TYPEAHEAD, DATE_TIME_PICKER, PHOTO}
Default value: "INLINE_SELECT"

conditional_questions_group_id
LeadGen Conditional Questions Group ID

thank_you_page
Object

Optional customized thank you page displayed post submission

title
string

Required
body
string

Required
short_message
string

button_text
string

button_description
string

business_phone_number
phone number string

enable_messenger
boolean
Default value: false

website_url
string

button_type
enum {VIEW_WEBSITE, CALL_BUSINESS, MESSAGE_BUSINESS, DOWNLOAD}

Required
country_code
string

tracking_parameters
JSON object {string : string}

Map for additional tracking parameters to include with the form's field data

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Validation Rules

ErrorDescription
100Invalid parameter
192Invalid phone number

Updating

You can update a Page by making a POST request to /{page_id}/assigned_users.

Parameters

ParameterDescription
tasks
array<enum {MANAGE, CREATE_CONTENT, MODERATE, ADVERTISE, ANALYZE, MODERATE_COMMUNITY, MANAGE_JOBS, PAGES_MESSAGING, PAGES_MESSAGING_SUBSCRIPTIONS, READ_PAGE_MAILBOXES, VIEW_MONETIZATION_INSIGHTS, MANAGE_LEADS, PLATFORM_MANAGE_PAGES, PLATFORM_READ_INSIGHTS, PLATFORM_PAGES_MANAGE_INSTANT_ARTICLES}>

Page permission tasks to assign this user

user
UID

Business user id or system user id

Required

Return Type

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

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
80001There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
You can update a Page by making a POST request to /{page_id}/page_whatsapp_number_verification.

Parameters

ParameterDescription
verification_code
string

The verification code which was sent to the WhatsApp number.

whatsapp_number
string

The WhatsApp number to be verified.

Required

Return Type

Struct {
error_message: string,
verification_status: enum,
whatsapp_number_type: int32,
}

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter

Deleting

Delete a Facebook Page.

This is only available to select developers. Please contact your Facebook Partner for more information.

You can dissociate a Page from a Page by making a DELETE request to /{page_id}/assigned_users.

Parameters

ParameterDescription
user
UID

Business user id or system user id

Required

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
You can dissociate a Page from a Page by making a DELETE request to /{page_id}/locations.

Parameters

ParameterDescription
location_page_id
location_page ID

Page ID for the page to delete

Required
store_number
int64

Store number for the page to delete

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
371Invalid Page location update
100Invalid parameter
200Permissions error