Graph API Version

Page Call To Action

A page access token with pages_manage_cta permission is required for creating, updating and deleting.

Reading

Page's call-to-action

Examples

Graph API Explorer
GET /v2.10/{page-call-to-action-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{page-call-to-action-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* 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();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* 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.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

android_app

App that stores the destination info on Android

android_deeplink

string

Destination deeplink for the call-to-action on Android

android_destination_type

enum

Destination type for the call-to-action on Android

android_package_name

string

Destination app for the call-to-action on Android

android_url

string

Destination url for the call-to-action on Android

created_time

datetime

Time when the call-to-action was created

email_address

string

Email address that can be contacted by a user

id

numeric string

ID of the call-to-action

from

Page that owns the call-to-action

intl_number_with_plus

string

International phone number with plus that can be called by a phone

iphone_app

App that stores the destination info on iPhone

iphone_deeplink

string

Destination deeplink for the call-to-action on iPhone

iphone_destination_type

enum

Destination type for the call-to-action on iPhone

iphone_url

string

Destination url for the call-to-action on iPhone

status

enum

Current running status of this action

type

enum

The type of action

updated_time

datetime

Time when the call-to-action was last updated

web_destination_type

enum

Destination type for the call-to-action on desktop

web_url

string

Destination url for the call-to-action on desktop

Edges

No edges

Validation Rules

ErrorDescription
100Invalid parameter

Creating

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

Permissions

Developers usually request these permissions for this endpoint:

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

Parameters

NameDescription
android_app_id
int

ID of the App that stores the destination info on Android

android_deeplink
string

Destination deeplink for the call-to-action on Android

android_destination_type
enum {WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, EMAIL, NONE}
Default value: NONE

Destination type for the call-to-action on Android

android_package_name
string

Destination app for the call-to-action on Android

android_url
URL

Destination url for the call-to-action on Android

email_address
string

Email address that can be contacted by a user

intl_number_with_plus
string

International phone number with plus that can be called through a phone

iphone_app_id
int

ID fo the App that stores the destination info on iPhone

iphone_deeplink
string

Destination deeplink for the call-to-action on iPhone

iphone_destination_type
enum {WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, EMAIL, NONE}
Default value: NONE

Destination type for the call-to-action on iPhone

iphone_url
URL

Destination url for the call-to-action on iPhone

type
enum {BOOK_NOW, CALL_NOW, CHARITY_DONATE, CONTACT_US, DONATE_NOW, MESSAGE, OPEN_APP, PLAY_NOW, SHOP_NOW, SIGN_UP, WATCH_NOW, GET_OFFER, GET_OFFER_VIEW, REQUEST_QUOTE, BOOK_APPOINTMENT, LISTEN, EMAIL, LEARN_MORE, REQUEST_APPOINTMENT, GET_DIRECTIONS, BUY_TICKETS, PLAY_MUSIC, VISIT_GROUP}

The type of action

Required
web_destination_type
enum {EMAIL, MESSENGER, NONE, WEBSITE}
Default value: NONE

Destination type for the call-to-action on desktop

web_url
URL

Destination url for the call-to-action on desktop

Return Type

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

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
210User not visible

Updating

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

Permissions

Developers usually request these permissions for this endpoint:

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

Parameters

NameDescription
android_app_id
int

ID of the App that stores the destination info on Android

android_deeplink
string

Destination deeplink for the call-to-action on Android

android_destination_type
enum {WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, EMAIL, NONE}

Destination type for the call-to-action on Android

android_package_name
string

Destination app for the call-to-action on Android

android_url
URL

Destination url for the call-to-action on Android

email_address
string

Email address that can be contacted by a user

intl_number_with_plus
string

International phone number with plus that can be called through a phone

iphone_app_id
int

ID fo the App that stores the destination info on iPhone

iphone_deeplink
string

Destination deeplink for the call-to-action on iPhone

iphone_destination_type
enum {WEBSITE, APP_DEEPLINK, FACEBOOK_APP, PHONE_CALL, MESSENGER, EMAIL, NONE}

Destination type for the call-to-action on iPhone

iphone_url
URL

Destination url for the call-to-action on iPhone

type
enum {BOOK_NOW, CALL_NOW, CHARITY_DONATE, CONTACT_US, DONATE_NOW, MESSAGE, OPEN_APP, PLAY_NOW, SHOP_NOW, SIGN_UP, WATCH_NOW, GET_OFFER, GET_OFFER_VIEW, REQUEST_QUOTE, BOOK_APPOINTMENT, LISTEN, EMAIL, LEARN_MORE, REQUEST_APPOINTMENT, GET_DIRECTIONS, BUY_TICKETS, PLAY_MUSIC, VISIT_GROUP}

The type of action

web_destination_type
enum {EMAIL, MESSENGER, NONE, WEBSITE}

Destination type for the call-to-action on desktop

web_url
URL

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

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
210User not visible

Deleting

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

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
200Permissions error