Graph API Version

Page

Represents a Facebook Page.

Over the coming months, all classic Pages will be migrated to the New Pages Experience. Use the has_transitioned_to_new_page_experience Page field to determine if a Page has been migrated. After all Pages have been migrated, the classic Pages experience will no longer be available.

Refer to our Pages API Guides for additional usage information.

Reading

Get information about a Facebook Page.

Starting September 14, 2021, the following fields will throw an error for version 12.0+ calls made by apps that lack the endpoint's required permissions. This change will apply to all versions on December 13, 2021.

  • connected_instagram_account
  • connected_page_backed_instagram_account
  • instagram_business_account

Requirements

Limitations

  • A Page access token is required for any fields that may include User information.
  • All users requesting access to a Page using permissions must be able to perform the

    MODERATE task

    on the Page being queried.

  • When using the Page Public Content Access feature, use a system user access token to avoid rate limiting issues.

Public Page Data

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

Page StatusAccess TokenFeature, to retrieve public dataPermissions, to retrieve Page owned data

Unpublished

Page Access Token or User Access Token

None

None

Published, Unrestricted

App Access Token or User Access Token

PPCA or PPMA

pages_read_engagement pages_read_user_content pages_show_list

Published, Restricted

Page Access Token or User Access Token.

PPCA or PPMA

pages_read_engagement pages_read_user_content pages_show_list

Example

curl -i -X GET "https://graph.facebook.com/PAGE-ID&access_token=ACCESS-TOKEN"

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

The ID representing a Facebook Page.

about
string

Information about the Page. Can be read with Page Public Content Access or Page Public Metadata Access. This value maps to the Description setting in the Edit Page Info user interface. Limit of 100 characters.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

app_id
id

App ID for app-owned Pages and app Pages

artists_we_like
string

Artists the band likes. Applicable to Bands. Can be read with Page Public Content Access or Page Public Metadata Access.

attire
string

Dress code of the business. Applicable to Restaurants or Nightlife. Can be one of Casual, Dressy or Unspecified. Can be read with Page Public Content Access or Page Public Metadata Access.

awards
string

The awards information of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

band_interests
string

Band interests. Applicable to Bands. Can be read with Page Public Content Access or Page Public Metadata Access.

band_members
string

Members of the band. Applicable to Bands. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access. Limit of 100 characters.

birthday
string

Birthday of this person. Applicable to Pages representing people. Can be read with Page Public Content Access or Page Public Metadata Access.

booking_agent
string

Booking agent of the band. Applicable to Bands. Can be read with Page Public Content Access or Page Public Metadata Access.

built
string

Year vehicle was built. Applicable to Vehicles. Can be read with Page Public Content Access or Page Public Metadata Access.

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 the Page has checkin functionality enabled. Can be read with Page Public Content Access or Page Public Metadata Access.

can_post
bool

Indicates whether the current app user can post on this Page. Can be read with Page Public Content Access or Page Public Metadata Access.

category
string

The Page's category. e.g. Product/Service, Computers/Technology. Can be read with Page Public Content Access or Page Public Metadata Access.

category_list

The Page's sub-categories. This field will not return the parent category.

checkins
unsigned int32

Number of checkins at a place represented by a Page

company_overview
string

The company overview. Applicable to Companies. Can be read with Page Public Content Access or Page Public Metadata Access.

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>

Instagram usernames who 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. Can be read with Page Public Content Access or Page Public Metadata Access.

cover

Information about the page's cover photo

culinary_team
string

Culinary team of the business. Applicable to Restaurants or Nightlife. Can be read with Page Public Content Access or Page Public Metadata Access.

current_location
string

Current location of the Page. Can be read with Page Public Content Access or Page Public Metadata Access. To manage a child Page's location use the /{page-id}/locations endpoint.

delivery_and_pickup_option_info
list<string>

A Vector of url strings for delivery_and_pickup_option_info of the Page.

description
string

The description of the Page. Can be read with Page Public Content Access or Page Public Metadata Access. Note that this value is mapped to the Additional Information setting in the Edit Page Info user interface.

description_html
string

The description of the Page in raw HTML. Can be read with Page Public Content Access or Page Public Metadata Access.

differently_open_offerings
list<KeyValue:enum,bool>

To be used when temporary_status is set to differently_open to indicate how the business is operating differently than usual, such as a restaurant offering takeout. Enum keys can be one or more of the following: ONLINE_SERVICES, DELIVERY, PICKUP, OTHER with the value set to true or false. For example, a business offering food pick up but pausing delivery would be differently_open_offerings:{"DELIVERY":"false", "PICKUP":"true"}

directed_by
string

The director of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

display_subtext
string

Subtext about the Page being viewed. Can be read with Page Public Content Access or Page Public Metadata Access.

displayed_message_response_time
string

Page estimated message response time displayed to user. Can be read with Page Public Content Access or Page Public Metadata Access.

emails
list<string>

The emails listed in the About section of a Page. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access. For New Page Experience Pages, this field will return followers_count.

featured_video

Video featured by the Page

features
string

Features of the vehicle. Applicable to Vehicles. Can be read with Page Public Content Access or Page Public Metadata Access.

followers_count
unsigned int32

Number of page followers

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. Can be read with Page Public Content Access or Page Public Metadata Access.

general_info
string

General information provided by the Page. Can be read with Page Public Content Access or Page Public Metadata Access.

general_manager
string

General manager of the business. Applicable to Restaurants or Nightlife. Can be read with Page Public Content Access or Page Public Metadata Access.

genre
string

The genre of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

global_brand_page_name
string

The name of the Page with country codes appended for Global Pages. Only visible to the Page admin. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access.

has_transitioned_to_new_page_experience
bool

indicates whether a page has transitioned to new page experience or not

has_whatsapp_business_number
bool

Indicates whether WhatsApp number connected to this page is a WhatsApp business number. Can be read with Page Public Content Access or Page Public Metadata Access.

has_whatsapp_number
bool

Indicates whether WhatsApp number connected to this page is a WhatsApp number. Can be read with Page Public Content Access or Page Public Metadata Access.

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 with: { "hours": { "mon_1_open": "09:00", //open at 9am on Monday "mon_1_close": "12:00", //close at 12pm "mon_2_open": "13:15", //open at 1:15pm "mon_2_close": "18:00". //close at 6pm } 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, use the is_always_open field instead. Note: If a business is open during the night, the closing time can not pass 6:00am. For example, "mon_2_open":"13:15" and "mon_2_close":"5:59" will work however "mon_close_close":"6:00" will not.

impressum
string

Legal information about the Page publishers. Can be read with Page Public Content Access or Page Public Metadata Access.

influences
string

Influences on the band. Applicable to Bands. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Values can be APPROVED, NOT_SUBMITTED, PENDING, REJECTED, or SUSPENDED.

is_always_open
bool

Indicates whether this location is always open. Can be read with Page Public Content Access or Page Public Metadata Access.

is_chain
bool

Indicates whether location is part of a chain. Can be read with Page Public Content Access or Page Public Metadata Access.

is_community_page
bool

Indicates whether the Page is a community Page. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

is_owned
bool

Indicates whether Page is owned. Can be read with Page Public Content Access or Page Public Metadata Access.

is_permanently_closed
bool

Whether the business corresponding to this Page is permanently closed. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

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_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

members
string

Members of this org. Applicable to Pages representing Team Orgs. Can be read with Page Public Content Access.

merchant_id
string

The instant workflow merchant ID associated with the Page. Can be read with Page Public Content Access or Page Public Metadata Access.

merchant_review_status
enum

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

messaging_feature_status
MessagingFeatureStatus

messaging_feature_status

messenger_ads_default_icebreakers
list<string>

The default ice breakers for a certain page

messenger_ads_default_page_welcome_message
MessengerDestinationPageWelcomeMessage

The default page welcome message for Click to Messenger Ads

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. Values include UNKNOWN, PAGE_SHOP, or RETAIL.

mission
string

The company mission. Applicable to Companies

mpg
string

MPG of the vehicle. Applicable to Vehicles. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

new_like_count
unsigned int32

The number of people who have liked the Page, since the last login. Only visible to a Page admin. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access.

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. Can be read with Page Public Content Access.

personal_interests
string

Personal interests. Applicable to Pages representing People. Can be read with Page Public Content Access or Page Public Metadata Access.

pharma_safety_info
string

Pharmacy safety information. Applicable to Pharmaceutical companies. Can be read with Page Public Content Access or Page Public Metadata Access.

phone
string

Phone number provided by a Page. Can be read with Page Public Content Access.

pickup_options
list<enum>

List of pickup options available at this Page's store location. Values can include CURBSIDE, IN_STORE, and OTHER.

place_type
enum

For places, the category of the place. Value can be CITY, COUNTRY, EVENT, GEO_ENTITY, PLACE, RESIDENCE, STATE_PROVINCE, or TEXT.

plot_outline
string

The plot outline of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

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.. Can be read with Page Public Content Access or Page Public Metadata Access.

privacy_info_url
string

Privacy url in page info section

produced_by
string

The productor of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

rating_count
unsigned int32

Number of ratings for the Page (limited to ratings that are publicly accessible). Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

release_date
string

The film's release date. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

screenplay_by
string

The screenwriter of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

season
string

The season information of the TV Show. Applicable to TV Shows. Can be read with Page Public Content Access or Page Public Metadata Access.

single_line_address
string

The Page address, if any, in a simple single line format. Can be read with Page Public Content Access or Page Public Metadata Access.

starring
string

The cast of the film. Applicable to Films. Can be read with Page Public Content Access or Page Public Metadata Access.

start_info

Information about when the entity represented by the Page was started

store_code
string

Unique store code for this location Page. Can be read with Page Public Content Access or Page Public Metadata Access.

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_donate_button_in_live_video
bool

Whether the user can add a Donate Button to their Live Videos.

supports_instant_articles
bool

Indicates whether this Page supports Instant Articles

talking_about_count
unsigned int32

The number of people talking about this Page

temporary_status
enum

Indicates how the business corresponding to this Page is operating differently than usual. Possible values:

  • differently_open
  • temporarily_closed
  • operating_as_usual
  • no_data

If set to differently_open use with differently_open_offerings to set status.

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. Value can be blue_verified or gray_verified, which represents that Facebook has confirmed that a Page is the authentic presence of the public figure, celebrity, or global brand it represents, or not_verified. This field can be read with the Page Public Metadata Access feature.

voip_info

Voip info

website
string

The URL of the Page's website. Can be read with Page Public Content Access or Page Public Metadata Access.

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. Can be read with Page Public Content Access or Page Public Metadata Access.

whatsapp_number
string

The Page's WhatsApp number. Can be read with Page Public Content Access or Page Public Metadata Access.

written_by
string

The writer of the TV show. Applicable to TV Shows. Can be read with Page Public Content Access or Page Public Metadata Access.

Edges

EdgeDescription

The ad posts for this Page

Businesses that have agency permissions on the Page

Users assigned to this Page. Can be read with Page Public Content Access.

The music copyrights owned by this page (using alacorn)

Business projects

The canvas elements associated with this page

The canvas documents associated with this page

customization configuration values of the Page's corresponding Chat Plugin

The commerce orders of this Page

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

Pages that are allowed to crosspost

custom_labels

Custom user settings for a page

Returns the Events on a Page.

This Page's feed. Can be read with Page Public Content Access.

Children Pages of a Global Pages root Page. Both default and root Page can return children Pages. Can be read with Page Public Content Access.

groups

Image copyrights from this page

Videos of a page. Can be read with Page Public Content Access.

This Page's Insights data

Linked Instagram accounts for this Page

A library of lead generation forms created for this page.

Live encoders owned by this Page

Live videos on this Page. Can be read with Page Public Content Access.

The location Pages that are children of this Page. Can be read with Page Public Content Access. To manage a child Page's location use the /{page-id}/locations endpoint.

Media fingerprints from this page

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

The native offers created by this Page. Can be read with Page Public Content Access.

Messenger Platform Bot personas for the Page

This Page's Photos. Can be read with Page Public Content Access.

This Page's profile picture

This Page's own Posts, a derivative of the /feed edge. Can be read with Page Public Content Access.

All published posts by this page

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

Secondary Receivers for a page

Controllable settings for this page

Shows the shop setup status

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. Can be read with Page Public Content Access.

App which owns a thread for Handover Protocol

Messenger platform configs for the page

Video copyright rules from this page

Video copyrights from this page

Video copyrights from this page using alacorn

Videos for this Page. Can be read with Page Public Content Access.

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token
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.
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.
80005There have been too many leadgen 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.
210User not visible
9009Instagram user is unavailable

Creating

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

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,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
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>

Blocks of entities of the About Story. A block can be composed of an entity such as a header, a paragraph, a list, a link, or an image and can include styling of elements within each block. Required.

  • depth (int, optional)- The indent value of text. Only takes effect when type is UNORDERED_LIST_ITEM or ORDERED_LIST_ITEM.
  • entity_ranges (array, optional) - Describes an MEDIA entity such as an image or link.
    • offset (non-negative int) - The index of the entity from the left side border where index starts at 0. For IMAGE, this should be 0 since the image itself always take up a block. For LINK, for example, your text is “Welcome to Facebook” and you want “Facebook” to be a link. Set offset to 10, since “F” is the 10th character, and length to 8 since "Facebook" is 8 characters long.
    • length (non-negative int) - The number of characters of the entity. For IMAGE, this should be 1. offset plus length cannot be greater than the length of the text content.
    • key (int) - Used to find the IMAGE or LINK in the entity_map This key should be identical to the key of entity_map.
  • inline_style_ranges (array, optional) - The style applied to a word or group of text within a line in the text block. Value can be one of the following:
    • length - The number of characters the style is applied to.
    • offset - The index of the start of the styling. Indexing starts at 0.
    • style - The style to apply to the characters. The value can be one of the following: BOLD, CODE, ITALIC, NONE, or UNDERLINE.
  • text (string, optional) - The text of the About Story
  • type (string, optional) - The style type. Value can be on of the following: BLOCKQUOTE, CODE, HEADER_ONE, HEADER_TWO, MEDIA,ORDERED_LIST_ITEM, UNORDERED_LIST_ITEM, or UNSTYLED.

depth
int64
Default value: 0

depth

entity_ranges
array<JSON object>
Default value: []

entity_ranges

key
int64
Default value: 0

key

length
int64
Default value: 0

length

offset
int64
Default value: 0

offset

inline_style_ranges
array<JSON object>
Default value: []

inline_style_ranges

length
int64
Default value: 0

length

offset
int64
Default value: 0

offset

style
enum {NONE, BOLD, ITALIC, UNDERLINE, CODE}
Default value: "NONE"

style

text
string
Default value: ""

text

type
enum {UNSTYLED, UNORDERED_LIST_ITEM, ORDERED_LIST_ITEM, BLOCKQUOTE, HEADER_ONE, HEADER_TWO, CODE, MEDIA}
Default value: "UNSTYLED"

type

cover_photo
JSON object {string : int64}

The cover photo of your Page About Story.

  • photo_id - The ID of the photo that has already been uploaded to Facebook. Required
  • x_offset - The horizontal offset. (int)
  • y_offset - The horizontal offset. (int)

entity_map
array<JSON object>

Description of an entity map. Values include:

  • caption - The description under the image.
  • key - Should be the same value as the key of composed_text[entity_ranges] . Required.
  • photo_id - Required for PHOTO type.
  • position - Position of an image: CENTER (default),LEFT , RIGHT .
  • size - Size of image:NONE (default), COLUMN , LARGE , or MAXIMUM. Only used when position is set to CENTER .
  • type (enum) - IMAGE or LINK . Required.
  • url - A link within your text. Required when type is set to LINK .

key
int64

key

Required
type
enum {LINK, IMAGE}

type

Required
url
string

url

photo_id
int64

photo_id

caption
string

caption

position
enum {CENTER, LEFT, RIGHT}

position

size
enum {NONE, COLUMN, LARGE, MAXIMUM}

size

is_published
boolean

Indicated if the About Story is published or not.

title
string
Default value: ""

The title of your Page About Story.

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,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
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
api_version
enum {}

The Wit API version to use.

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.

n_best
int64

The number of intents and traits to return, other than the best one.

nlp_enabled
boolean

A boolean to enable/disable Built-In NLP.

other_language_support
JSON object {string : JSON object}

A map of language to model type and Wit token for language identification.

Return Type

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

Error Codes

ErrorDescription
100Invalid parameter
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 /v6.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();
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/v6.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, inbox_labels, standby, message_mention, messages, message_reactions, messaging_account_linking, messaging_checkout_updates, messaging_customer_information, 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, messaging_fblogin_account_linking, user_action, messaging_feedback, founded, company_overview, mission, products, general_info, leadgen, leadgen_fat, location, hours, parking, public_transit, page_about_story, mcom_invoice_change, invoice_access_invoice_change, invoice_access_onboarding_status_active, local_delivery, phone, email, website, ratings, attire, payment_options, culinary_team, general_manager, price_range, awards, hometown, current_location, bio, affiliation, birthday, personal_info, personal_interests, members, checkins, page_upcoming_change, page_change_proposal, merchant_review, product_review, videos, live_videos, video_text_question_responses, registration, publisher_subscriptions}>

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,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
210User not visible
190Invalid OAuth 2.0 Access Token
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.

Updating

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

Parameters

ParameterDescription
about
UTF-8 string

Update the about field. Note that this value is mapped to the Description setting in the Edit Page Info user interface.

Supports Emoji
accept_crossposting_handshake
array<JSON object>

Accepts a pending crossposting request initiated by another Page

partner_page_id
page ID

partner_page_id

Required
allow_live
boolean

allow_live

Required
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

partner_page_id
page ID

partner_page_id

Required
allow_live
boolean

allow_live

Required
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

delivery_and_pickup_option_info
array<string>

delivery_and_pickup_option_info. Each String represent the url link to a delivery and pick up option webpage. The API filters out duplicated urls as well as invalidated urls. If empty array is input, delivery_and_pickup_option_info field of the page will be cleared.

description
string

Update the description field. Note that this value is mapped to the Additional Information setting in the Edit Page Info user interface.

differently_open_offerings
JSON object {enum {ONLINE_SERVICES, DELIVERY, PICKUP, OTHER} : boolean}

Indication of services currently offered by this business. Specify "true" for all that apply. Intended to be used when temporary_status = 'differently_open'.

Note to restaurants: See restaurant_services for how to indicate longer term or permanent aspects of your business.

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

pickup_options
array<enum {CURBSIDE, IN_STORE, OTHER}>

List of pickup option types available at this Page's business location

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

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

temporary_status
enum {DIFFERENTLY_OPEN, TEMPORARILY_CLOSED, OPERATING_AS_USUAL, NO_DATA}

Update the temporary_status 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,
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
370Invalid call to update this page
371Invalid Page location update
210User not visible
374Invalid store location descriptor update since this Page is not a location Page.
375This Page doesn't have a location descriptor. Add one to continue.
160Invalid geolocation type
320Photo edit failure
You can update a Page by making a POST request to /{page_id}/assigned_users.

Parameters

ParameterDescription
tasks
array<enum {MANAGE, CREATE_CONTENT, MODERATE, MESSAGING, ADVERTISE, ANALYZE, MODERATE_COMMUNITY, MANAGE_JOBS, PAGES_MESSAGING, PAGES_MESSAGING_SUBSCRIPTIONS, READ_PAGE_MAILBOXES, VIEW_MONETIZATION_INSIGHTS, MANAGE_LEADS, PROFILE_PLUS_FULL_CONTROL, PROFILE_PLUS_MANAGE, PROFILE_PLUS_FACEBOOK_ACCESS, PROFILE_PLUS_CREATE_CONTENT, PROFILE_PLUS_MODERATE, PROFILE_PLUS_MESSAGING, PROFILE_PLUS_ADVERTISE, PROFILE_PLUS_ANALYZE, PROFILE_PLUS_REVENUE, CASHIER_ROLE}>

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,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
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,
whatsapp_display_number: string,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error

Deleting

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 scoped user id

Required

Return Type

Struct {
success: bool,
}

Error Codes

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,
}

Error Codes

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