FigureCollection.update

Update the title in place; use replace for content changes.

Signature

update(figure_id: str, *, title: str) -> Figure

Parameters

Name	Type	Required	Default
figure_id	str	yes	-
title	str	yes	-

HTTP parameters

Name	In	Type	Required	Default
figure_id	path	string	yes	-

Fields

Schema: FigureUpdateSchema

Field	Type	Required
author	string	no
config	object	no
dataset_id	string	no
figure	object	no
frames	array<object>	no
name	string	no
notebook_id	string	no
plotly_version	string	no
producer	string	no
source_provenance	object	no
spec	object	no
title	string	no

Return shape

HTTP 200 — OK

Schema: FigureSchema

Field	Type	Required
author	string	no
config	object	no
conversation_id	string	no
created_at	string	yes
dataset_id	string	no
figure	object	yes
frames	array<object>	no
id	string	yes
name	string	yes
notebook_id	string	no
original_upload_hash	string	no
original_upload_id	string	no
owner_id	string	no
plotly_version	string	no
point_count	integer	no
producer	string	no
project_id	string	yes
revision	integer	no
size_bytes	integer	no
source	string	yes
source_provenance	object	no
spec	object	no
support_report	object	no
title	string	no
updated_at	string	yes
validation_reasons	array<string>	no
validation_status	string	no

Permission

Required permission: figure:update

HTTP

PATCH /api/figures/{figure_id}/ (updateFigure)

Usage

figure_collection.update(figure_id, title)