Skip to main content
Version: Next

CanvasRestApi.post

certification_detailsstringnullable

Details of the certification.

certified_bystringnullable

Person or group that has certified this canvas.

cssstringnullable

Custom CSS applied to the canvas page.

definitionobjectnullable

Initial canvas definition. Changed afterwards only through the definition operations endpoint.

descriptionstringnullable

What the canvas shows, for readers and agents.

editorsinteger[]
external_urlstringnullable

Where the canvas is managed when managed externally.

is_managed_externallybooleannullable

Whether the canvas is managed by an external system, e.g. as code.

slugstringnullable

Readable key for the canvas URL, e.g. /canvas/sales-overview/. Unique, not all digits, and not 'list'.

Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d+$)(?!list$)[\w-]+$

theme_idintegernullable

Theme applied to the canvas; the default theme when unset.

titlestringrequired

The canvas' title.

Possible values: non-empty and <= 500 characters

viewersinteger[]
CanvasRestApi.post
{
"certification_details": "string",
"certified_by": "string",
"css": "string",
"definition": {},
"description": "string",
"editors": [
0
],
"external_url": "string",
"is_managed_externally": true,
"slug": "string",
"theme_id": 0,
"title": "string",
"viewers": [
0
]
}