Meta Developer Docs

Appearance

Fresh 2026

Page Call To Action ​

Reading ​

Returns data on PageCallToAction node.

New Page Experience ​

This endpoint is supported for New Page Experience.

Example ​

HTTPPHP SDKJavaScript SDKAndroid SDKiOS SDK Graph API Explorer

GET /v25.0/{page-call-to-action-id} 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-call-to-action-id}',
    '{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-call-to-action-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-call-to-action-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]\
                               initWithGraphPath:@"/{page-call-to-action-id}"\
                                      parameters:params\
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,\
                                      id result,\
                                      NSError *error) {\
    // Handle the result\
}];

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

Requirements ​

TypeDescription
App ReviewYour app must be be approved for the following login permissions and features.
Login permissionsNone
FeaturesPage Public Content Access
TokensA User access token for a User who has a role on the Page
PermissionsNone

Parameters ​

This endpoint doesn't have any parameters.

Fields ​

FieldDescription
id<br>numeric stringID of the call-to-action<br>Default
android_app<br>ApplicationApp that stores the destination info on Android
android_deeplink<br>stringDestination deeplink for the call-to-action on Android
android_destination_type<br>enumDestination type for the call-to-action on Android
android_package_name<br>stringDestination app for the call-to-action on Android
android_url<br>stringDestination url for the call-to-action on Android
created_time<br>datetimeTime when the call-to-action was created
email_address<br>stringEmail address that can be contacted by a user
from<br>PagePage that owns the call-to-action
intl_number_with_plus<br>stringInternational phone number with plus that can be called by a phone
iphone_app<br>ApplicationApp that stores the destination info on iPhone
iphone_deeplink<br>stringDestination deeplink for the call-to-action on iPhone
iphone_destination_type<br>enumDestination type for the call-to-action on iPhone
iphone_url<br>stringDestination url for the call-to-action on iPhone
status<br>enumCurrent running status of this action<br>Default
type<br>enumThe type of action<br>Default
updated_time<br>datetimeTime when the call-to-action was last updated
web_destination_type<br>enumDestination type for the call-to-action on desktop
web_url<br>stringDestination url for the call-to-action on desktop

Error Codes ​

ErrorDescription
104Incorrect signature
100Invalid parameter

Creating ​

You can't perform this operation on this endpoint.

Updating ​

This endpoint is deprecated and can no longer be used.

You can update a PageCallToAction by making a POST request to /{page_call_to_action_id}.

Requirements ​

TypeDescription
App ReviewYour app must be be approved for the following login permissions and features.
Login permissionspages_manage_cta
FeaturesNone
TokensA Page access token for an admin of the Page
Permissionspages_manage_cta

Parameters ​

ParameterDescription
android_app_id<br>intID of the App that stores the destination info on Android
android_destination_type<br>enum {WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, EMAIL, SHOP_ON_FACEBOOK, NONE, BECOME_A_VOLUNTEER, FOLLOW, MINI_SHOP, MARKETPLACE_INVENTORY_PAGE, MOBILE_CENTER, MENU_ON_FACEBOOK}Destination type for the call-to-action on Android
android_package_name<br>stringDestination app for the call-to-action on Android
android_url<br>URLDestination url for the call-to-action on Android
email_address<br>stringEmail address that can be contacted by a user
intl_number_with_plus<br>stringInternational phone number with plus that can be called through a phone
iphone_app_id<br>intID fo the App that stores the destination info on iPhone
iphone_destination_type<br>enum {WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, EMAIL, SHOP_ON_FACEBOOK, NONE, BECOME_A_VOLUNTEER, FOLLOW, MINI_SHOP, MARKETPLACE_INVENTORY_PAGE, MENU_ON_FACEBOOK}Destination type for the call-to-action on iPhone
iphone_url<br>URLDestination url for the call-to-action on iPhone
type<br>enum {BOOK_NOW, REQUEST_QUOTE, CALL_NOW, CHARITY_DONATE, CONTACT_US, DONATE_NOW, MESSAGE, OPEN_APP, PLAY_NOW, SHOP_NOW, SIGN_UP, WATCH_NOW, GET_OFFER, GET_OFFER_VIEW, BOOK_APPOINTMENT, LISTEN, EMAIL, LEARN_MORE, REQUEST_APPOINTMENT, GET_DIRECTIONS, BUY_TICKETS, PLAY_MUSIC, VISIT_GROUP, SHOP_ON_FACEBOOK, LOCAL_DEV_PLATFORM, INTERESTED, WOODHENGE_SUPPORT, BECOME_A_VOLUNTEER, VIEW_SHOP, PURCHASE_GIFT_CARDS, FOLLOW_PAGE, ORDER_FOOD, VIEW_INVENTORY, MOBILE_CENTER, VIEW_MENU, CHECK_IN, CREATOR_STOREFRONT}The type of action
web_destination_type<br>enum {EMAIL, MESSENGER, NONE, WEBSITE, SHOP_ON_FACEBOOK, BECOME_SUPPORTER, BECOME_A_VOLUNTEER, FOLLOW, MOBILE_CENTER}Destination type for the call-to-action on desktop
web_url<br>URLDestination url for the call-to-action on desktop

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

Deleting ​

You can delete a PageCallToAction by making a DELETE request to /{page_call_to_action_id}.

Requirements ​

TypeDescription
App ReviewYour app must be be approved for the following login permissions and features.
Login permissionspages_manage_cta
FeaturesNone
TokensA Page access token for an admin of the Page
Permissionspages_manage_cta

Parameters ​

This endpoint doesn't have any parameters.

Return Type ​

Struct {

success: bool,

}

Error Codes ​

ErrorDescription
200Permissions error