Skip to main content
PUT
/
folders
/
{folder_token}
Update folder
curl --request PUT \
  --url https://api.vantage.sh/v2/folders/{folder_token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "parent_folder_token": "<string>",
  "saved_filter_tokens": [
    "<string>"
  ]
}
'
import requests

url = "https://api.vantage.sh/v2/folders/{folder_token}"

payload = {
"title": "<string>",
"parent_folder_token": "<string>",
"saved_filter_tokens": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
parent_folder_token: '<string>',
saved_filter_tokens: ['<string>']
})
};

fetch('https://api.vantage.sh/v2/folders/{folder_token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vantage.sh/v2/folders/{folder_token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'parent_folder_token' => '<string>',
'saved_filter_tokens' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.vantage.sh/v2/folders/{folder_token}"

payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"parent_folder_token\": \"<string>\",\n \"saved_filter_tokens\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.vantage.sh/v2/folders/{folder_token}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"parent_folder_token\": \"<string>\",\n \"saved_filter_tokens\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vantage.sh/v2/folders/{folder_token}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"parent_folder_token\": \"<string>\",\n \"saved_filter_tokens\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "token": "fldr_68e18d8d7df0be96",
  "title": "New Title",
  "parent_folder_token": "fldr_9aa0c735a6b615c6",
  "created_at": "2023-09-12T05:06:53Z",
  "updated_at": "2023-09-12T05:06:53Z",
  "workspace_token": "wrkspc_e65a48e5d9684439"
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}
{
"errors": [
"<string>"
],
"links": {
"self": "<string>",
"first": "<string>",
"next": "<string>",
"last": "<string>",
"prev": "<string>"
}
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

folder_token
string
required

Body

application/json

Update a Folder for CostReports.

title
string

The title of the Folder.

parent_folder_token
string

The token of the parent Folder.

saved_filter_tokens
string[]

The tokens of the SavedFilters to apply to any Cost Report contained within the Folder.

Response

Folder model

token
string
required
title
string | null
required

The title of the Folder.

Example:

"Platform Team Reports"

type
string
required

The type of the Folder.

saved_filter_tokens
string[]
required

The tokens for the SavedFilters assigned to the Folder.

created_at
string
required

The date and time, in UTC, the Folder was created. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"

updated_at
string
required

The date and time, in UTC, the Folder was last updated at. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"

workspace_token
string
required

The token for the Workspace the Folder is a part of.

parent_folder_token
string | null

The token for the parent Folder, if any.