Update all chart properties
PUT
https://api.datawrapper.de/v3/charts/{id} Replaces the entire metadata object. Requires scope chart:write.
Example Request
curl --request PUT \
--url https://api.datawrapper.de/v3/charts/example-id \
--header 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
--header 'Content-Type: application/json' \
--data '{
"title": "My cool chart",
"theme": "datawrapper",
"type": "d3-lines"
}'Headers
| Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Yes | The format of the request body. |
Path Parameters
| Name | Type | Allowed values | Required | Description |
|---|---|---|---|---|
id | string | 5 characters | Yes | 5 character long chart ID. |
Request Body
| Field | Type | Allowed values | Required | Description |
|---|---|---|---|---|
title | string | No | Title of your chart. This will be the chart headline. | |
theme | string | matches ^[a-z0-9]+(?:-{1,2}[a-z0-9]+)*$ 2 characters or more | No | |
type | string | matches ^[a-z0-9]+(?:-{1,2}[a-z0-9]+)*$ | No | Type of the chart (Reference) |
externalData | string | No | URL of external dataset | |
language | string | matches ^[a-z]{2}([_-][A-Z]{2})?$ | No | Visualization locale (e.g. en-US) |
lastEditStep | integer | 1 to 5 | No | Current position in chart editor workflow |
publicVersion | integer | No | ||
publicUrl | string | No | ||
publishedAt | string | No | ||
metadata | object | No | Metadata that saves all chart specific settings and options. | |
metadata.data | object | No | ||
metadata.data.transpose | boolean | No | ||
authorId | integer | No | ||
organizationId | string | No | ID of the team (formerly known as organization) that the visualization should be created in. The authenticated user must have access to this team. | |
folderId | integer | No | ID of the folder that the visualization should be created in. The authenticated user must have access to this folder. | |
organization_id | string | No | Deprecated. Use organizationId instead. | |
folder_id | integer | No | Deprecated. Use folderId instead. | |
inFolder | integer | No | Deprecated. Use folderId instead. | |
in_folder | integer | No | Deprecated. Use folderId instead. | |
external_data | string | No | Deprecated. Use externalData instead. | |
last_edit_step | integer | 1 to 5 | No | Deprecated. Use lastEditStep instead. |
author_id | integer | No | Deprecated. Use authorId instead. | |
public_version | integer | No | Deprecated. Use publicVersion instead. | |
public_url | string | No | Deprecated. Use publicUrl instead. | |
published_at | string | No | Deprecated. Use publishedAt instead. |
Response
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | ID of the visualization |
title | string | No | Title of the visualization |
publicId | string | No | Public ID of the visualization. May be different from the internal ID, if *hash publishing* is enabled. |
authorId | integer | No | ID of user that created the visualization. |
organizationId | string | No | ID of the team that the visualization is located in. If null, visualization is private. |
folderId | integer | No | ID of the folder that the visualization is located in. If null, visualization is in the root of a team, or your private archive. |
folder | object | No | |
folder.name | string | No | User-defined folder name |
language | string | No | Visualization language (output locale), e.g en-US |
theme | string | No | ID of theme applied to the visualization |
type | string | No | Type of visualization, e.g d3-lines, d3-maps-choropleth, tables |
createdAt | string | No | Time and date when the visualization was created. |
lastModifiedAt | string | No | Time and date when the visualization was last edited. |
publishedAt | string | No | Time and date when the visualization was last published. null, if the visualization has not been published yet. |
lastEditStep | integer | No | A number encoding which of the editor steps this chart has been edited in so far. 5 = published. |
publicVersion | integer | No | Indicates how many times a visualization has been published. |
author | object | No | |
author.name | string | No | Name of the user who created the visualization |
author.email | string | No | Email address of the user who created the visualization |
author.avatar | string | No | URL pointing to the user avatar |
author.color | string | No | Color chosen by the user |
thumbnails | object | No | |
thumbnails.full | string | No | URL pointing to the most recently generated preview thumbnail for the visualization. (Image includes header & footer). |
thumbnails.plain | string | No | URL pointing to the most recently generated preview thumbnail for the visualization. (Image is just the visualization, without header & footer). |
url | string | No | API URL for the visualization, can be used to retreive additional information, including its metadata. |
guestSession | string | No | Guest session id |
downloadImageFilename | string | No | Download image filename |
downloadDataFilename | string | No | Download data filename |
sourceImageFilenames | object | No | Source image filenames |
sourceImageFilenames.png | string | No | |
sourceImageFilenames.svg | string | No | |
sourceImageFilenames.pdf | string | No | |
readonlyKeys | string[] | No | |
openComments | integer | No | Number of comments on the visualization |
workspaceTeamSettings | object | No | Frontend-allowed team and workspace settings |
deletionInDays | number | No | Number of days until the visualization will be permanently deleted. |
deletedBy | object | No | User who moved the visualization to the trash. |
deletedBy.name | string | No | Name of the user who moved the visualization to the trash. |
deletedBy.email | string | No | Email address of the user who moved the visualization to the trash. |
deletedBy.avatar | string | No | URL pointing to the user avatar |
deletedBy.color | string | No | Color chosen by the user |
publicUrl | string | No | URL of published visualization. |
deleted | boolean | No | |
deletedAt | string | No | Time and date when the visualization was deleted. |
forkable | boolean | No | Indicates if the visualization has been shared in the Datawrapper River. |
isFork | boolean | No | Indicates if the visualization is a copy of another visualization. |
forkedFrom | string | No | ID of the visualization that this visualization was copied from. null if it is not a copy. |
externalData | string | No | External data URL, relevant for live visualizations. |
metadata | object | No | All of the visualization's settings. |
chartHash | string | No | Hash of the visualization's metadata. |
customFields | object | No | |
keywords | string | No | Keywords |
utf8 | boolean | No | UTF-8 |
river | object | No | |
river.source | string | No | |
river.sourceUrl | string | No | |
basedOnByline | string | No | |
workspace | string | No |