Update a folder

PUT/projects/:project_id/folders/:folder_id

Base URL https://test-management.testsigma.com/api/v1

Updates the name or display order of a specific folder within a project.

Authenticate with your API key as a Bearer token in the Authorization header. Generate a key →

PATH PARAMETERS

`project_id`	Unique identifier of the project that contains the folder.
`folder_id`	Unique identifier of the folder to update.

REQUEST BODY

`name`	New name of the folder.
`order`	Order in which the folder should be displayed. A value of -1 indicates the order is not set.

RESPONSE ATTRIBUTES

`message`	Status message for the request; may be empty.
`data.folder.id`	Unique identifier of the folder.
`data.folder.name`	Updated name of the folder.
`data.folder.project_id`	Identifier of the project to which the folder belongs.
`data.folder.children`	Array of child folders, if any.
`data.folder.parent_folder_id`	Identifier of the parent folder, if applicable.
`data.folder.order`	Updated order index of the folder.

REQUEST

curl -X PUT \
  'https://test-management.testsigma.com/api/v1/projects/:project_id/folders/:folder_id' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Regression Suite (Updated)",
    "order": -1
  }'

const response = await fetch('https://test-management.testsigma.com/api/v1/projects/:project_id/folders/:folder_id', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "name": "Regression Suite (Updated)",
      "order": -1
  })
});
const data = await response.json();

import requests

response = requests.put(
  'https://test-management.testsigma.com/api/v1/projects/:project_id/folders/:folder_id',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "name": "Regression Suite (Updated)",
      "order": -1
  }
)
data = response.json()

RESPONSE200OK

{
  "message": "",
  "data": {
    "folder": {
      "id": "c69216e0-e2a9-401f-9e08-77176abce8c4",
      "name": "Regression Suite (Updated)",
      "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
      "children": [],
      "parent_folder_id": "",
      "order": -1
    }
  }
}