Updates a folder

PATCH

https://api.datawrapper.de/v3/folders/{id}

Update a folder. Requires scope folder:write.

Example Request

curl --request PATCH \
  --url https://api.datawrapper.de/v3/folders/12345 \
  --header 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "parentId": 0
}'

Headers

Name	Value	Required	Description
`Content-Type`	`application/json`	Yes	The format of the request body.

Path Parameters

Name	Type	Required	Description
`id`	`number`	Yes	Folder ID.

Request Body

Field	Type	Required	Description
`name`	`string`	No	Folder name.
`parentId`	`number`	No	Parent folder.
`userId`	`string`	No	The user this folder belongs to.
`teamId`	`string`	No	The team this folder belongs to.

Response

Field	Type	Required	Description
`id`	`integer`	No
`name`	`string`	No	User-defined folder name
`userId`	`integer`	No	If set, this is a private folder, and it belongs to the indicated user. If unset, the folder is located in a shared team archive (see `teamId`).
`teamId`	`string`	No	The ID of the team that this folder is in. If unset, this folder is private.
`parentId`	`integer`	No	The id of the folder that this folder is in. If 'null', the folder is in the root of either a team, or your private charts. (See `userId` and `teamId`, to determine which)
`workspace`	`string`	No	Slug of the workspace that the folder is in.
`children`	`object[]`	No	List of top-level subfolders of this folder.
`children.id`	`integer`	No
`charts`	`object[]`	No	List of visualizations in this folder. To access the visualizations in subfolders of this folder, those folders must be queried separately.
`charts.id`	`string`	No