Graph API Version

Canvas

Reading

A canvas document

Example

Graph API Explorer
GET /v5.0/{canvas-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(
    '/{canvas-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(
    "/{canvas-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{canvas-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:@"/{canvas-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
id
numeric string

ID of the canvas

background_color
string

Background color of the canvas

body_elements
list<CanvasPhoto|CanvasHeader|CanvasVideo|CanvasText|CanvasCarousel|CanvasDynamicCarousel|CanvasButton|CanvasFooter|CanvasStoreLocator|CanvasProductList|CanvasProductSet|CanvasLeadForm|CanvasDynamicText>

Body element nodes for the canvas

canvas_link
string

The canvas link for the canvas

is_hidden
bool

The canvas is hidden or not

is_published
bool

Publish status of the canvas

last_editor

User who last edited this canvas

name
string

Name used to label the canvas

owner

Page that owns this canvas

update_time
int32

Last updated time of the canvas

Validation Rules

ErrorDescription
100Invalid parameter

Creating

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

Parameters

ParameterDescription
background_color
string
Default value: FFFFFFFF

Background color of the canvas

body_element_ids
list<numeric string or integer>

A list of all canvas element ids inside this canvas

enable_swipe_to_open
boolean
Default value: false

Field used to mark if swipe to open is enabled

is_hidden
boolean

Field used to mark if the canvas is visible or not

is_published
boolean
Default value: false

Field used to mark the publish state of the canvas

name
string
Default value: Untitled Canvas

Field used to label docs by the editor tool

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
105The number of parameters exceeded the maximum for this operation

Updating

You can update a Canvas by making a POST request to /{canvas_id}.

Parameters

ParameterDescription
background_color
string

Background color of the canvas

body_element_ids
list<numeric string or integer>

A list of canvas element ids

enable_swipe_to_open
boolean

Field used to mark if swipe to open is enabled

is_hidden
boolean

Field used to hide a (published) canvas

is_published
boolean

Field used to mark the publish state of the canvas

name
string

Field used to label the canvas

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
210User not visible
262Incorrect permission to publish pages

Deleting

You can't perform this operation on this endpoint.