Graph API
Graph API Version

Canvas Button

Reading

A button inside the canvas

Example

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The id of the element

action
CanvasOpenURLAction

The action associated with the button

background_color
string

Color of the button background

bottom_padding
numeric string

The padding below the element

button_color
string

Color of the button

button_style
enum

The style of the button

element_group_key
string

The element group key to bundle multiple elements in editing

element_type
enum

The type of the element

Default
name
string

The name of the element

Default
rich_text
CanvasRichText

The text inside the button

top_padding
numeric string

The padding above the element

Error Codes

ErrorDescription
368The action attempted has been deemed abusive or is otherwise disallowed

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.