Partial update canvas

patch

https://{organization}.my.pitcher.com/api/v1/canvases/{canvas_id}/

Partially updates a canvas.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

canvas_id

string

required

A unique value identifying this canvas.

Query Params

exclude_drafts

boolean

Exclude draft sections from sections array and section_ids. Defaults to true.

fields

string

Fields to return.

include_expired_files

boolean

Defaults to false

Include expired files.

include_pending_files

boolean

Defaults to false

Include pending files.

pspdfkit_layer

string

enum

Defaults to base

PDF Annotation Layer to display.

Allowed:

return_empty

boolean

Return empty response.

Body Params

name

string

length between 1 and 255

content

object

context

string

indicators

object | null

theme

object | null

is_draft

boolean

is_template

boolean

is_section

boolean

is_block

boolean

is_editable

boolean

is_default

boolean

metadata

string

tags

start_at

date-time | null

expires_at

date-time | null

access_type

string

enum

public - Public
restricted - Restricted
personal - Personal

Allowed:

thumbnail_url

uri | null

instance_id

string

length ≥ 1

account

object | null

folder_id

string | null

owned_by_id

integer | null

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200