PATCH /folders/{id}

1 min

PATCH

https://api.cmp.optimizely.com/v3/folders/{id}

Experimental Update a folder's name and/or parent.

Path Parameters

idstringrequired
Example
5d7f910551b00a722e0418830cee6632
Description
Unique identifier of the folder

Body Parameters

bodyFolderUpdateRequestrequired
Description
Payload to update a folder
- object
- object

Responses

200Updated Folder

FolderResponse
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6632
  Description
  Unique identifier of the folder
- namestringrequired
  Example
  icons
  Description
  Name of the folder
- parent_folder_idstringrequired
  Example
  1d9d8aeca10811ebbc640242ac12001b
  Description
  ID of the parent folder
- pathstringrequired
  Example
  /images/icons
  Description
  Folder location
- created_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the folder was created, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time of the most recent modification of the folder, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/folders/5d7f910551b00a722e0418830cee6632
    Description
    URL of the folder
  - parent_folderstringrequired
    Example
    https://api.cmp.optimizely.com/v3/folders/1d9d8aeca10811ebbc640242ac12001b
    Description
    URL of the parent of the folder
  - child_foldersstringrequired
    Example
    https://api.cmp.optimizely.com/v3/folders?parent_folder_id=5d7f910551b00a722e0418830cee6632
    Description
    URL of the children list of the folder
  - assetsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/assets?folder_id=5d7f910551b00a722e0418830cee6632&include_subfolder_assets=false
    Description
    URL of the assets inside the folder

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request PATCH \
     --url https://api.cmp.optimizely.com/v3/folders/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/folders/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/folders/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/folders/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Updated Folder
{
  "id": "5d7f910551b00a722e0418830cee6632",
  "name": "icons",
  "parent_folder_id": "1d9d8aeca10811ebbc640242ac12001b",
  "path": "/images/icons",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/folders/5d7f910551b00a722e0418830cee6632",
    "parent_folder": "https://api.cmp.optimizely.com/v3/folders/1d9d8aeca10811ebbc640242ac12001b",
    "child_folders": "https://api.cmp.optimizely.com/v3/folders?parent_folder_id=5d7f910551b00a722e0418830cee6632",
    "assets": "https://api.cmp.optimizely.com/v3/assets?folder_id=5d7f910551b00a722e0418830cee6632&include_subfolder_assets=false"
  }
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}