Graph API Version

Page

This represents a Facebook Page. The /{page-id} node returns a single page.

Related Guides

To manage a child Page's location use the /{page-id}/locations edge.

Reading

Feature Permissions

Name	Description
Page Public Content Access	This feature permission may be required.

Returns a Page.

Permissions

For pages that are published, you need:

An App or User access token to view fields from fully public pages.
A User access token to view fields from restricted pages that this person is able to view (such as those restrict to certain demographics like location or age, or those only viewable by Page admins).
A Page access token can also be used to view those restricted fields. A Page access token is required to view any User information for any objects owned by a Page.
You need to be the Admin of the root page for child pages in order to read the global_brand_children edge for a page.
The source field will not be returned for Page-owned videos unless the User making the request is an admin of the owning Page.

For pages that are not published, you need:

To have the Admin role for the page
A Page access token

Example

Graph API Explorer

GET /v4.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',
    '{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 https://graph.facebook.com/v4.0/{page-id}/locations?fields=location%7Blatitude%2Clongitude%7D%2Cis_permanently_closed&limit=30000

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter Description

Parameter	Description
`account_linking_token` UTF-8 encoded string	Short lived account linking token (5 mins expiry) to get the PSID for a user-page pair

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

Field	Description
`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` AdSet	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	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` 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 Core
`category_list` list<PageCategory>	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` MailingAddress	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` CoverPhoto	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 Core
`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` 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	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_has_crm_integration` bool	Indicates whether this page hasApp subscribes page leads realtime update
`leadgen_has_fat_ping_crm_integration` bool	Indicates whether this pagehas App that subscribes page leads realtime update via fat ping
`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` User	Indicates the user who accepted the TOS for running LeadGen Ads on the page
`link` string	The Page's Facebook URL Core
`location` 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 Core Default
`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` 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` PageParking	Parking information. Applicable to Businesses and Places
`payment_options` PagePaymentOptions	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` PageRestaurantServices	Services the restaurant provides. Applicable to Restaurants
`restaurant_specialties` PageRestaurantSpecialties	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` PageStartInfo	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' Core
`verification_status` string	Showing whether this Page is verified and in what color e.g. blue verified, gray verified or not verified
`voip_info` VoipInfo	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

Edge	Description
`ads_posts`	The ad posts for this Page
`agencies`	Businesses that have agency permissions on the Page
`albums`	Photo albums for this Page
`assigned_users`	Users assigned to this page
`audio_media_copyrights`	The music copyrights owned by this page (using alacorn)
`blocked`	User or Page Profiles blocked from this Page
`businessprojects`	Business projects
`canvas_elements`	The canvas elements associated with this page
`canvases`	The canvas documents associated with this page
`claimed_urls`	Claimed URLs for Instant Articles that are associated with this Facebook Page
`conversations`	This Page's conversations
`copyright_whitelisted_partners`	Whitelisted pages and users that will not be reported in the copyright match systems
`crosspost_whitelisted_pages`	Pages whitelisted for crossposting
`events`	Returns the Events on a Page.
`featured_videos_collection`	Featured Videos for this Page
`feed`	This Page's wall
`global_brand_children`	Children Pages of a Global Pages root Page. Both default and root Page can return children Pages
`insights`	This Page's Insights data
`insights_exports`	List of all insights reports from a Page
`instagram_accounts`	Linked Instagram accounts for this Page
`instant_articles`	Instant articles associated with this Page
`instant_articles_insights`	Instant article insights aggregated over all instant articles for that page
`leadgen_forms`	A library of lead generation forms created for this page.
`likes`	The Pages that this Page has liked Core
`live_encoders`	Live encoders owned by this Page
`live_videos`	Live videos from this page
`locations`	The location Pages that are children of this Page
`media_fingerprints`	Media fingerprints from this page
`members` string	Members of this org. Applicable to Pages representing Team Orgs
`messaging_feature_review`	Feature status of the page that has been granted through feature review that show up in the page settings
`messenger_profile`	SELF_EXPLANATORY
`nativeoffers`	The native offers created by this Page
`notes` Edge	This Page's notes
`notifications` Edge	Notifications for this Page
`page_backed_instagram_accounts`	Gets the Page Backed Instagram Account (an InstagramUser) associated with this Page.
`personas`	Messenger Platform Bot personas for the Page
`photos`	This Page's photos
`picture`	This Page's profile picture Core
`place_topics`	The place topic associated with the categories of the page
`posts`	This Page's own posts, a derivative of /feed
`product_catalogs`	Product catalogs owned by this page
`published_posts`	All published posts by this page
`questions` Edge	The Page's questions
`roles`	The Page's Admins
`scheduled_posts`	All posts that are scheduled to a future date by a page
`screennames`	External accounts. Applicable to Pages representing people
`secondary_receivers`	Secondary Receivers for a page
`settings`	Controllable settings for this page
`show_playlists`	Playlists for this show page
`subscribed_apps`	Applications that have real time update subscriptions for this Page. Note that we will only return information about the current app
`tagged`	The photos, videos, and posts in which the Page has been tagged. A derivative of /feeds
`thread_owner`	App which owns a thread for Handover Protocol
`threads`	Deprecated. Use conversations instead
`tours`	tours
`video_copyright_rules`	Video copyright rules from this page
`video_copyrights`	Video copyrights from this page
`video_lists`	Video Playlists for this Page
`video_media_copyrights`	Video copyrights from this page using alacorn
`videos`	Videos for this Page
`visitor_posts`	Shows all public posts published by page visitors on the page

Validation Rules

Error	Description
100	Invalid parameter
80001	There 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.
200	Permissions error
80002	There 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.
210	User not visible
80006	There 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.
110	Invalid user id
190	Invalid OAuth 2.0 Access Token
159	Invalid 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:

/{business_id}/client_pages

When posting to this edge, a Page will be created.

Parameters

Parameter Description

Parameter	Description
`page_id` Page ID	Page ID. Required

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

Error	Description
100	Invalid parameter
200	Permissions error
3991	You have exceeded the number of allowed Page requests for your Business Manager at this time.
3988	You do not have permission to request access to the given object.
3946	Asset already belongs to this Business Manager.

You can make a POST request to owned_pages edge from the following paths:

/{business_id}/owned_pages

When posting to this edge, a Page will be created.

Parameters

Parameter Description

Parameter	Description
`page_id` Page ID	Page ID. Required

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

Error	Description
413	Invalid password
3977	To claim a Page in Business Manager, you must already be an Admin of the Page.
200	Permissions error
3982	You do not have sufficient permissions to import this asset into the given Business Manager.
3944	Your Business Manager already has access to this object.
100	Invalid parameter
3948	Please 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:

/{page_id}/subscribed_apps

When posting to this edge, a Page will be created.

Example

Graph API Explorer

POST /v4.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 \
     -d "subscribed_fields=leadgen" \
        https://graph.facebook.com/v4.0/{page-id}/subscribed_apps

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter Description

Parameter	Description
`subscribed_fields` array<enum {feed, mention, name, picture, category, description, conversations, branded_camera, feature_access_list, standby, messages, 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, 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

subscribed_fields

array<enum {feed, mention, name, picture, category, description, conversations, branded_camera, feature_access_list, standby, messages, 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, 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

Error	Description
200	Permissions error
100	Invalid parameter
210	User not visible

You can make a POST request to leadgen_forms edge from the following paths:

/{page_id}/leadgen_forms

When posting to this edge, a Page will be created.

Parameters

Parameter	Description
`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}
`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

Error	Description
100	Invalid parameter
192	Invalid phone number

You can make a POST request to personas edge from the following paths:

/{page_id}/personas

When posting to this edge, a Page will be created.

Parameters

Parameter Description

Parameter	Description
`name` string	Name of a Persona Required
`profile_picture_url` URI	Profile picture of a Persona Required

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

Error	Description
100	Invalid parameter
200	Permissions error

You can make a POST request to nlp_configs edge from the following paths:

/{page_id}/nlp_configs

When posting to this edge, a Page will be created.

Parameters

Parameter	Description
`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

Error	Description
200	Permissions error

You can make a POST request to copyright_whitelisted_ig_partners edge from the following paths:

/{page_id}/copyright_whitelisted_ig_partners

When posting to this edge, a Page will be created.

Parameters

Parameter Description

Parameter	Description
`usernames` array<string>	List of Instagram usernames to whitelist Required

usernames

array<string>

List of Instagram usernames to whitelist

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Map {

string: bool

}

Validation Rules

Error	Description
100	Invalid parameter

You can make a POST request to page_about_story edge from the following paths:

/{page_id}/page_about_story

When posting to this edge, a Page will be created.

Parameters

Parameter	Description
`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

Error	Description
54001	There 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.
100	Invalid parameter
210	User not visible

You can make a POST request to feed edge from the following paths:

/{page_id}/feed

When posting to this edge, a Page will be created.

Example

Graph API Explorer

POST /v4.0/{page-id}/feed HTTP/1.1
Host: graph.facebook.com

message=This+is+a+test+value

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/{page-id}/feed',
    array (
      'message' => 'This is a test value',
    ),
    '{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}/feed",
    "POST",
    {
        "message": "This is a test value"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Bundle params = new Bundle();
params.putString("message", "This is a test value");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/feed",
    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 = @{
  @"message": @"This is a test value",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/feed"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X POST \
     -d "message=This+is+a+test+value" \
        https://graph.facebook.com/v4.0/{page-id}/feed

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter	Description
`actions`	SELF_EXPLANATORY
`adaptive_type` string	adaptive_type
`album_id` numeric string	SELF_EXPLANATORY
`android_key_hash` string	SELF_EXPLANATORY
`animated_effect_id` int64	animated_effect_id
`application_id` non-empty string	SELF_EXPLANATORY
`asked_fun_fact_prompt_id` int64	asked_fun_fact_prompt_id
`asset3d_id` int64	asset3d_id
`associated_id` numeric string or integer	SELF_EXPLANATORY
`attach_place_suggestion` boolean	Default value: `false` SELF_EXPLANATORY
`attached_media` list<Object>	SELF_EXPLANATORY
`media_fbid` numeric string
`message` UTF-8 string	Supports Emoji
`audience_exp` boolean	Default value: `false` SELF_EXPLANATORY
`backdated_time` datetime	SELF_EXPLANATORY
`backdated_time_granularity` enum{year, month, day, hour, min, none}	Default value: `none` SELF_EXPLANATORY
`call_to_action` Object	SELF_EXPLANATORY Supports Emoji
`type` enum{BOOK_TRAVEL, CONTACT_US, DONATE, DONATE_NOW, DOWNLOAD, GET_DIRECTIONS, GO_LIVE, INTERESTED, LEARN_MORE, LIKE_PAGE, MESSAGE_PAGE, SAVE, SEND_TIP, SHOP_NOW, SIGN_UP, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE, LOYALTY_LEARN_MORE, GET_MOBILE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, INSTALL_APP, USE_APP, PLAY_GAME, WATCH_VIDEO, WATCH_MORE, OPEN_LINK, NO_BUTTON, LISTEN_MUSIC, MOBILE_DOWNLOAD, GET_OFFER, GET_OFFER_VIEW, BUY_NOW, BUY_TICKETS, UPDATE_APP, BET_NOW, ADD_TO_CART, ORDER_NOW, SELL_NOW, GET_SHOWTIMES, LISTEN_NOW, GET_EVENT_TICKETS, SEARCH_MORE, PRE_REGISTER, BOOK_TEST_DRIVE, CHECK_AVAILABILITY, CALL, MISSED_CALL, CALL_NOW, CALL_ME, APPLY_NOW, BUY, GET_QUOTE, SUBSCRIBE, RECORD_NOW, VOTE_NOW, GIVE_FREE_RIDES, REGISTER_NOW, OPEN_MESSENGER_EXT, EVENT_RSVP, CIVIC_ACTION, SEND_INVITES, REQUEST_TIME, SEE_MENU, WHATSAPP_MESSAGE, SEARCH, TRY_IT, TRY_ON, LINK_CARD, DIAL_CODE, FIND_YOUR_GROUPS}	The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used for based on the `objective` of your campaign. Required
`value` Object	Default value: `Array` JSON containing the call to action data. Supports Emoji
`link` URL
`app_link` string
`page` numeric string or integer
`link_format` enum {VIDEO_LEAD, VIDEO_LPP, VIDEO_NEKO, VIDEO_NON_LINK, VIDEO_SHOP}
`application` numeric string or integer
`link_title` string	Supports Emoji
`link_description` string	Supports Emoji
`link_caption` string
`product_link` string
`get_movie_showtimes` boolean
`sponsorship` Object
`link` URL
`image` URL
`video_annotation` Object
`annotations` list<Object>
`start_time_in_sec` int64
`end_time_in_sec` int64
`link` URL
`link_title` string
`link_description` string
`link_caption` string
`image_url` URL
`header_color` string
`logo_url` URL
`post_click_cta_title` string
`post_click_description_title` string
`offer_id` numeric string or integer
`offer_view_id` numeric string or integer
`advanced_data` Object
`offer_id` numeric string or integer
`lead_gen_form_id` numeric string or integer
`fundraiser_campaign_id` numeric string or integer
`event_id` numeric string or integer
`event_tour_id` numeric string or integer
`app_destination` enum {MESSENGER, MESSENGER_EXTENSIONS, MESSENGER_GAMES, LINK_CARD, MARKETPLACE}
`app_destination_page_id` numeric string or integer
`is_canvas_video_transition_enabled` boolean
`whatsapp_number` string
`preinput_text` string
`customized_message_page_cta_text` string
`external_offer_provider_id` numeric string or integer
`caption` string	SELF_EXPLANATORY Supports Emoji
`checkin_entry_point` enum {BRANDING_CHECKIN, BRANDING_STATUS, BRANDING_PHOTO, BRANDING_OTHER}	Default value: `BRANDING_OTHER` checkin_entry_point
`child_attachments` list<Object>	SELF_EXPLANATORY Supports Emoji
`picture` URL
`name` string	Supports Emoji
`link` URL	Required
`caption` string	Supports Emoji
`description` string	Supports Emoji
`quote` UTF-8 string	Supports Emoji
`source` URL
`properties`
`object_attachment` numeric string or integer
`height` int64
`width` int64
`expanded_height` int64
`expanded_width` int64
`referral_id` numeric string or integer
`thumbnail` file
`image_crops` dictionary { enum{191x100, 100x72, 400x150, 600x360, 100x100, 400x500, 90x160} : <list<list<int64>>> }
`call_to_action` Object	Supports Emoji
`type` enum{BOOK_TRAVEL, CONTACT_US, DONATE, DONATE_NOW, DOWNLOAD, GET_DIRECTIONS, GO_LIVE, INTERESTED, LEARN_MORE, LIKE_PAGE, MESSAGE_PAGE, SAVE, SEND_TIP, SHOP_NOW, SIGN_UP, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE, LOYALTY_LEARN_MORE, GET_MOBILE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, INSTALL_APP, USE_APP, PLAY_GAME, WATCH_VIDEO, WATCH_MORE, OPEN_LINK, NO_BUTTON, LISTEN_MUSIC, MOBILE_DOWNLOAD, GET_OFFER, GET_OFFER_VIEW, BUY_NOW, BUY_TICKETS, UPDATE_APP, BET_NOW, ADD_TO_CART, ORDER_NOW, SELL_NOW, GET_SHOWTIMES, LISTEN_NOW, GET_EVENT_TICKETS, SEARCH_MORE, PRE_REGISTER, BOOK_TEST_DRIVE, CHECK_AVAILABILITY, CALL, MISSED_CALL, CALL_NOW, CALL_ME, APPLY_NOW, BUY, GET_QUOTE, SUBSCRIBE, RECORD_NOW, VOTE_NOW, GIVE_FREE_RIDES, REGISTER_NOW, OPEN_MESSENGER_EXT, EVENT_RSVP, CIVIC_ACTION, SEND_INVITES, REQUEST_TIME, SEE_MENU, WHATSAPP_MESSAGE, SEARCH, TRY_IT, TRY_ON, LINK_CARD, DIAL_CODE, FIND_YOUR_GROUPS}	The type of the action. Not all types can be used for all ads. Check Ads Product Guide to see which type can be used for based on the `objective` of your campaign. Required
`value` Object	Default value: `Array` JSON containing the call to action data. Supports Emoji
`link` URL
`app_link` string
`page` numeric string or integer
`link_format` enum {VIDEO_LEAD, VIDEO_LPP, VIDEO_NEKO, VIDEO_NON_LINK, VIDEO_SHOP}
`application` numeric string or integer
`link_title` string	Supports Emoji
`link_description` string	Supports Emoji
`link_caption` string
`product_link` string
`get_movie_showtimes` boolean
`sponsorship` Object
`link` URL
`image` URL
`video_annotation` Object
`annotations` list<Object>
`start_time_in_sec` int64
`end_time_in_sec` int64
`link` URL
`link_title` string
`link_description` string
`link_caption` string
`image_url` URL
`header_color` string
`logo_url` URL
`post_click_cta_title` string
`post_click_description_title` string
`offer_id` numeric string or integer
`offer_view_id` numeric string or integer
`advanced_data` Object
`offer_id` numeric string or integer
`lead_gen_form_id` numeric string or integer
`fundraiser_campaign_id` numeric string or integer
`event_id` numeric string or integer
`event_tour_id` numeric string or integer
`app_destination` enum {MESSENGER, MESSENGER_EXTENSIONS, MESSENGER_GAMES, LINK_CARD, MARKETPLACE}
`app_destination_page_id` numeric string or integer
`is_canvas_video_transition_enabled` boolean
`whatsapp_number` string
`preinput_text` string
`customized_message_page_cta_text` string
`external_offer_provider_id` numeric string or integer
`image_hash` string
`static_card` boolean
`video_id` numeric string or integer
`offer_id` numeric string or integer
`client_mutation_id` string	SELF_EXPLANATORY
`composer_entry_picker` string	composer_entry_picker
`composer_entry_point` string	composer_entry_point
`composer_entry_time` int64	composer_entry_time
`composer_session_events_log` JSON-encoded string	composer_session_events_log
`composer_session_id` string	SELF_EXPLANATORY
`composer_source_surface` string	composer_source_surface
`composer_type` string	composer_type
`connection_class` string	SELF_EXPLANATORY
`content_attachment` numeric string	content_attachment
`coordinates` JSON-encoded coordinate list	SELF_EXPLANATORY
`cta_link` string	cta_link
`cta_type` string	cta_type
`description` string	SELF_EXPLANATORY Supports Emoji
`direct_share_status` int64	direct_share_status
`enforce_link_ownership` boolean	Default value: `false` SELF_EXPLANATORY
`expanded_height` int64	SELF_EXPLANATORY
`expanded_width` int64	SELF_EXPLANATORY
`feed_targeting` feed target	SELF_EXPLANATORY
`geo_locations` Object
`countries` list<string>
`regions` list<Object>
`key` int64
`cities` list<Object>
`key` int64
`zips` list<Object>
`key` string
`locales` list<string>	Values for targeted locales. Use `type` of `adlocale` to find Targeting Options and use the returned key to specify.
`age_min` int64	Must be `13` or higher. Default is 0.
`age_max` int64	Maximum age.
`genders` list<int64>	Target specific genders. `1` targets all male viewers and `2` females. Default is to target both.
`college_years` list<int64>	Array of integers. Represent graduation years from college.
`education_statuses` list<int64>	Array of integers which represent current educational status. Use `1` for high school, `2` for undergraduate, and `3` for alum (or localized equivalents).
`interested_in` list<int64>	Deprecated. Please see the Graph API Changelog for more information. Deprecated
`relationship_statuses` list<int64>	Array of integers for targeting based on relationship status. Use `1` for single, `2` for 'in a relationship', `3` for married, and `4` for engaged. Default is all types.
`interests` list<int64>	One or more IDs of pages to target fans of pages.Use `type` of `page` to get possible IDs as find Targeting Options and use the returned id to specify.
`formatting` enum {PLAINTEXT, MARKDOWN}	formatting
`fun_fact_prompt_id` int64	fun_fact_prompt_id
`fun_fact_toastee_id` int64	fun_fact_toastee_id
`has_nickname` boolean	has_nickname
`height` int64	SELF_EXPLANATORY
`holiday_card` JSON-encoded string	holiday_card
`home_checkin_city_id` place tag	SELF_EXPLANATORY
`image_crops` dictionary { enum{191x100, 100x72, 400x150, 600x360, 100x100, 400x500, 90x160} : <list<list<int64>>> }	SELF_EXPLANATORY
`implicit_with_tags` list<int>	SELF_EXPLANATORY
`instant_game_entry_point_data` string	instant_game_entry_point_data
`ios_bundle_id` string	SELF_EXPLANATORY
`is_backout_draft` boolean	is_backout_draft
`is_boost_intended` boolean	is_boost_intended
`is_explicit_location` boolean	SELF_EXPLANATORY
`is_explicit_share` boolean	SELF_EXPLANATORY
`is_group_linking_post` boolean	is_group_linking_post
`is_photo_container` boolean	SELF_EXPLANATORY
`link` URL	SELF_EXPLANATORY
`location_source_id` numeric string or integer	location_source_id
`manual_privacy` boolean	Default value: `false` SELF_EXPLANATORY
`message` UTF-8 string	SELF_EXPLANATORY Supports Emoji
`multi_share_end_card` boolean	Default value: `true` SELF_EXPLANATORY
`multi_share_optimized` boolean	Default value: `true` SELF_EXPLANATORY
`name` string	SELF_EXPLANATORY Supports Emoji
`nectar_module` string	SELF_EXPLANATORY
`object_attachment` numeric string or integer	SELF_EXPLANATORY
`offer_like_post_id` int64	offer_like_post_id
`og_action_type_id` numeric string or integer	SELF_EXPLANATORY
`og_hide_object_attachment` boolean	SELF_EXPLANATORY
`og_icon_id` numeric string or integer	SELF_EXPLANATORY
`og_object_id` OG object ID or URL string	SELF_EXPLANATORY
`og_phrase` UTF-8 string	SELF_EXPLANATORY Supports Emoji
`og_set_profile_badge` boolean	Default value: `false` og_set_profile_badge
`og_suggestion_mechanism` string	SELF_EXPLANATORY
`page_recommendation` JSON-encoded string	page_recommendation
`picture` URL	SELF_EXPLANATORY
`place` place tag	SELF_EXPLANATORY
`place_attachment_setting` enum {1, 2}	Default value: `2` place_attachment_setting
`place_list` JSON-encoded string	place_list
`place_list_data` array	place_list_data
`post_surfaces_blacklist` list<enum {1, 2, 3, 4, 5}>	post_surfaces_blacklist
`posting_to_redspace` enum {enabled, disabled}	Default value: `disabled` posting_to_redspace
`privacy` Privacy Parameter	SELF_EXPLANATORY
`prompt_id` string	prompt_id
`prompt_tracking_string` string	prompt_tracking_string
`properties`	SELF_EXPLANATORY
`proxied_app_id` numeric string or integer	SELF_EXPLANATORY
`publish_event_id` int64	publish_event_id
`published` boolean	Default value: `true` SELF_EXPLANATORY
`quote` UTF-8 string	quote Supports Emoji
`react_mode_metadata` JSON-encoded string	This metadata is required for clip reacts feature
`ref` list<string>	Default value: `Default` SELF_EXPLANATORY
`referenceable_image_ids` list<numeric string or integer>	referenceable_image_ids
`referral_id` numeric string or integer	referral_id
`sales_promo_id` int64	sales_promo_id
`scheduled_publish_time` datetime	SELF_EXPLANATORY
`source` URL	SELF_EXPLANATORY
`sponsor_id` numeric string or integer	sponsor_id
`sponsor_relationship` int64	sponsor_relationship
`suggested_place_id` place tag	SELF_EXPLANATORY
`tags` list<int>	SELF_EXPLANATORY
`target_surface` enum {STORY, TIMELINE}	Default value: `"TIMELINE"` target_surface
`targeting` target	SELF_EXPLANATORY
`geo_locations` Object
`countries` list<string>
`regions` list<Object>
`key` int64
`cities` list<Object>
`key` int64
`zips` list<Object>
`key` string
`locales` list<string>
`excluded_countries` list<string>
`excluded_regions` list<int64>
`excluded_cities` list<int64>
`excluded_zipcodes` list<string>
`timezones` list<int64>
`age_min` enum {13, 17, 18, 19, 21}
`text_format_metadata` JSON-encoded string	text_format_metadata
`text_format_preset_id` numeric string or integer	text_format_preset_id
`text_only_place` string	SELF_EXPLANATORY
`throwback_camera_roll_media` JSON-encoded string	throwback_camera_roll_media
`thumbnail` file	SELF_EXPLANATORY
`time_since_original_post` int64	SELF_EXPLANATORY
`title` UTF-8 string	SELF_EXPLANATORY Supports Emoji
`tracking_info` JSON-encoded string	tracking_info
`unpublished_content_type` enum {SCHEDULED, SCHEDULED_RECURRING, DRAFT, ADS_POST, INLINE_CREATED, PUBLISHED}	SELF_EXPLANATORY
`user_selected_tags` boolean	Default value: `false` SELF_EXPLANATORY
`video_start_time_ms` int64	video_start_time_ms
`viewer_coordinates` JSON-encoded coordinate list	SELF_EXPLANATORY
`width` int64	SELF_EXPLANATORY

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: token with structure: Post ID,

post_supports_client_mutation_id: bool,

}

Validation Rules

Error	Description
200	Permissions error
100	Invalid parameter
506	Duplicate status message
197	The post is empty. Please enter a message to share.
368	The action attempted has been deemed abusive or is otherwise disallowed
80001	There 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.
105	The number of parameters exceeded the maximum for this operation
1500	The url you supplied is invalid

Updating

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

Parameters

Parameter	Description
`about` string	Update the `about` field
`accept_crossposting_handshake` array<JSON object>	Accepts a pending crossposting request initiated by another Page
`allow_spherical_photo` boolean	Default value: `false` Indicates that we should allow this photo to be treated as a spherical photo. This param will only be used when uploading a new image file. This will not change the behavior unless the server is able to interpret the photo as spherical, such as via Photosphere XMP metadata. Regular non-spherical photos will still be treated as regular photos even if this parameter is true.
`attire` enum{Unspecified, Casual, Dressy}	Update the `attire` field
`begin_crossposting_handshake` array<JSON object>	Begins the video crossposting handshake with another page
`bio` string	Update the `bio` field
`category_list` list<numeric string>	Update the `category_list` field
`company_overview` string	Update the `company_overview` field
`contact_address` Object	Update the `contact_address` field
`city_id` city id
`street1` string
`street2` string
`zip` string
`cover` numeric string or integer	Update the `cover` field. This field can only be updated by the Page Admin or Page Editor with `EDIT_PROFILE` and `business_management` permissions.
`culinary_team` string	Update the `culinary_team` field
`description` string	Update the `description` field
`directed_by` string	Update the `directed_by` field
`displayed_message_response_time` string	Page estimated message response time displayed to user
`emails` list<string>	Update the `emails` field
`focus_x` float	Cover photo focus x
`focus_y` float	Cover photo focus y
`food_styles` list<enum{Afghani, American (New), American (Traditional), Asian Fusion, Barbeque, Brazilian, Breakfast, British, Brunch, Buffets, Burgers, Burmese, Cajun/Creole, Caribbean, Chinese, Creperies, Cuban, Delis, Diners, Ethiopian, Fast Food, Filipino, Fondue, Food Stands, French, German, Greek and Mediterranean, Hawaiian, Himalayan/Nepalese, Hot Dogs, Indian/Pakistani, Irish, Italian, Japanese, Korean, Latin American, Mexican, Middle Eastern, Moroccan, Pizza, Russian, Sandwiches, Seafood, Singaporean, Soul Food, Southern, Spanish/Basque, Steakhouses, Sushi Bars, Taiwanese, Tapas Bars, Tex-Mex, Thai, Turkish, Vegan, Vegetarian, Vietnamese}>	Update the `food_styles` field
`general_info` string	Update the `general_info` field
`general_manager` string	Update the `general_manager` field
`genre` string	Update the `genre` field
`hours` dictionary { string : <> }	Update the `hours` field
`ignore_coordinate_warnings` boolean	Ignore coordinate warnings when updating this Page's location
`impressum` string	Update the `impressum` field
`instant_articles_submit_for_review` boolean	Submit Instant Articles on the Page for review
`is_always_open` boolean	Is this location always open?
`is_permanently_closed` boolean	Update the `is_permanently_closed` field
`is_published` boolean	Update the `is_published` field
`is_webhooks_subscribed` boolean	Is the application subscribed for real time updates from this page?
`location` Object	Update the `location` field
`city` string
`city_id` city id
`state` string
`country` string
`street` string
`zip` string
`latitude` float
`longitude` float
`mission` string	Update the `mission` field
`no_feed_story` boolean	Default value: `false` Don't generate a feed story for the cover photo
`no_notification` boolean	Default value: `false` Don't generate a notification for the cover photo
`offset_x` integer	Default value: `50` Cover photo offset x
`offset_y` integer	Default value: `50` Cover photo offset y
`parking` dictionary { enum{street, lot, valet} : <boolean> }	Update the `parking` field
`payment_options` dictionary { enum{visa, amex, mastercard, discover, cash_only} : <boolean> }	Update the `payment_options` field
`phone` string	Update the `phone` field
`plot_outline` string	Update the `plot_outline` field
`price_range` string	Update the `price_range` field
`public_transit` string	Update the `public_transit` field
`restaurant_services` dictionary { enum{reserve, walkins, groups, kids, takeout, delivery, catering, waiter, outdoor} : <boolean> }	Update the `restaurant_services` field
`restaurant_specialties` dictionary { enum{breakfast, lunch, dinner, coffee, drinks} : <boolean> }	Update the `restaurant_specialties` field
`scrape` boolean	Re-scrape the website associated with this Page
`service_details` string	Details of services provided by page. Can include delivery status/area/hours for the page.
`spherical_metadata` JSON object	A set of params describing an uploaded spherical photo. This param will only be used when uploading a new image file. This field is not required; if it is not present we will try to generate spherical metadata from the metadata embedded in the image. If it is present, it takes precedence over any embedded metadata. Please click to the left to expand this list and see more information on each parameter. See also the Google Photo Sphere spec for more info on the meaning of the params: https://developers.google.com/streetview/spherical-metadata
`ProjectionType` string	Accepted values include equirectangular (full spherical photo), cylindrical (panorama), and cubestrip (also known as cubemap, e.g. for synthetic or rendered content; stacked vertically with 6 faces). Required
`CroppedAreaImageWidthPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: Very similar to equirectangular. This value should be equal to the actual width of the image, and together with FullPanoWidthPixels, it describes the horizontal FOV of content of the image: HorizontalFOV = 360 * CroppedAreaImageWidthPixels / FullPanoWidthPixels. --- In cubestrip projection: This has no relationship to the pixel dimensions of the image. It is simply a representation of the horizontal FOV of the content of the image. HorizontalFOV = CroppedAreaImageWidthPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. Required
`CroppedAreaImageHeightPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value will NOT be equal to the actual height of the image. Instead, together with FullPanoHeightPixels, it describes the vertical FOV of the image: VerticalFOV = 180 * CroppedAreaImageHeightPixels / FullPanoHeightPixels. In other words, this value is equal to the CroppedAreaImageHeightPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. --- In cubestrip projection: This has no relationship to the pixel dimensions of the image. It is simply a representation of the vertical FOV of the content of the image. VerticalFOV = CroppedAreaImageHeightPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. Required
`FullPanoWidthPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: Very similar to equirectangular. This value defines a ratio of horizontal pixels to degrees in the space of the image, and in general the pixel to degree ratio in the scope of the metadata object. Concretely, PixelsPerDegree = FullPanoWidthPixels / 360. This is also equivalent to the circumference of the cylinder used to model this projection. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It only defines the pixel to degree ratio in the scope of the metadata object. It represents the number of pixels in 360 degrees, so pixels per degree is then given by: PixelsPerDegree = FullPanoWidthPixels / 360. As an example, if FullPanoWidthPixels were chosen to be 3600, we would have PixelsPerDegree = 3600 / 360 = 10. An image with a vertical field of view of 65 degrees would then have a CroppedAreaImageHeightPixels value of 65 * 10 = 650. Required
`FullPanoHeightPixels` int64	--- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value is equal to the FullPanoHeightPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. It is always equal to FullPanoWidthPixels / 2. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It is a second, redundant representation of PixelsPerDegree. FullPanoHeightPixels = 180 * PixelsPerDegree. It must be consistent with FullPanoWidthPixels: FullPanoHeightPixels = FullPanoWidthPixels / 2. Required
`CroppedAreaLeftPixels` int64	Default value: `0` --- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value is equal to the CroppedAreaLeftPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. Concretely, AngularOffsetFromLeftDegrees = CroppedAreaLeftPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. AngularOffsetFromLeftDegrees = CroppedAreaLeftPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels.
`CroppedAreaTopPixels` int64	Default value: `0` --- In equirectangular projection: As described in Google Photo Sphere XMP Metadata spec. --- In cylindrical projection: This value is equal to the CroppedAreaTopPixels value that this image would have, if it were projected into equirectangular format while maintaining the same FullPanoWidthPixels. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. Concretely, AngularOffsetFromTopDegrees = CroppedAreaTopPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels. --- In cubestrip projection: This value has no relationship to the pixel dimensions of the image. It is just a representation of the same angular offset that it represents in equirectangular projection in the Google Photo Sphere spec. AngularOffsetFromTopDegrees = CroppedAreaTopPixels / PixelsPerDegree, where PixelsPerDegree is defined by FullPanoWidthPixels.
`PoseHeadingDegrees` float
`PosePitchDegrees` float
`PoseRollDegrees` float
`InitialViewHeadingDegrees` float
`InitialViewPitchDegrees` float
`InitialViewRollDegrees` float	This is not currently supported
`InitialViewVerticalFOVDegrees` float	This is deprecated. Please use InitialVerticalFOVDegrees.
`InitialVerticalFOVDegrees` float	You can set the intial vertical FOV of the image. You can set either this field or InitialHorizontalFOVDegrees.
`InitialHorizontalFOVDegrees` float	You can set the intial horizontal FOV of the image. You can set either this field or InitialVerticalFOVDegrees.
`PreProcessCropLeftPixels` int64
`PreProcessCropRightPixels` int64
`start_info` Object	Update the `start_info` field
`type` enum{Unspecified, Born, Founded, Started, Opened, Created, Launched}	Required
`date` Object
`year` integer
`month` integer
`day` integer
`store_location_descriptor` string	Update the `store_location_descriptor` field
`website` URL	Update the `website` field
`zoom_scale_x` float	Cover photo zoom scale x
`zoom_scale_y` float	Cover photo zoom scale y

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

success: bool,

}

Validation Rules

Error	Description
100	Invalid parameter
200	Permissions error
210	User not visible
370	Invalid call to update this page
368	The action attempted has been deemed abusive or is otherwise disallowed
371	Invalid Page location update
190	Invalid OAuth 2.0 Access Token
375	This Page doesn't have a location descriptor. Add one to continue.
374	Invalid store location descriptor update since this Page is not a location Page.
320	Photo edit failure

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

Parameters

Parameter Description

Parameter	Description
`user` int	Business user id or system user id Required

user

int

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

Error	Description
200	Permissions error
100	Invalid 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

Parameter Description

Parameter	Description
`user` int	Business user id or system user id Required

user

int

Business user id or system user id

Required

Return Type

Struct {

success: bool,

}

Validation Rules

Error	Description
200	Permissions error
100	Invalid parameter

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

Parameters

Parameter Description

Parameter	Description
`usernames` array<string>	List of Instagram usernames to remove from your whitelist Required

usernames

array<string>

List of Instagram usernames to remove from your whitelist

Required

Return Type

Map {

string: bool

}

Validation Rules

Error	Description
100	Invalid parameter

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

Parameters

Parameter Description

Parameter	Description
`location_page_id` location_page ID	Page ID for the page to delete Required
`store_number` int64	Store number for the page to delete

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

Error	Description
371	Invalid Page location update
100	Invalid parameter
200	Permissions error