Graph API Version

Canvas Header

Reading

A header inside the canvas.

Example

use FacebookAds\Api;
use FacebookAds\Http\RequestInterface;

$params = array(
  'fields' => array(
    'child_elements',
    'id',
    'name',
  ),
);

$data = Api::instance()->call(
  '/' . <CANVAS_HEADER_ID>,
  RequestInterface::METHOD_GET,
  $params)->getContent();
curl -G \
  --data-urlencode 'fields=[ 
    "child_elements", 
    "id", 
    "name" 
  ]' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<CANVAS_HEADER_ID>

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The id of the element

background_color
string

The background color of the header

bottom_padding
numeric string

The padding below the element

child_elements
list<CanvasPhoto>

The child elements inside the header. You can only specify images, not text or other media.

element_group_key
string

The element group key to bundle multiple elements in editing

element_type
enum

The type of the element

name
string

The name of the element

top_padding
numeric string

The padding above the element

Error Codes

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can update a CanvasHeader by making a POST request to /{canvas_header_id}.

Parameters

ParameterDescription
background_color
string

The background color of the header

child_elements
array<rich_media_photo_element ID>

The child elements inside the header. You can only specify images, not text or other media.

name
string

Name of the header element

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

Deleting

You can delete a CanvasHeader by making a DELETE request to /{canvas_header_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter