---
updatedAt: 2026-04-21T03:46:21.000Z
agentTools:
projectIndex: https://help.rainforestqa.com/llms.txt
---
# Update a folder
Update a folder
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Rainforest API Documentation",
"description": "Nearly all interactions done on in Rainforest can be done in via the API.
Find your API Token (for the CLIENT_TOKEN header field) on the integration settings page.",
"version": "1"
},
"security": [
{
"api_key": []
}
],
"tags": [
{
"name": "folders",
"description": "Operations about folders"
}
],
"paths": {
"/1/folders/{id}": {
"put": {
"summary": "Update a folder",
"description": "Update a folder",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/put-folder"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Folder updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SmartFolder"
}
}
}
},
"400": {
"description": "Could not update folder",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Folder not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"tags": [
"folders"
],
"operationId": "put-folder",
"x-rdme-order": 11
}
}
},
"servers": [
{
"url": "//app.rainforestqa.com/api"
}
],
"components": {
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "CLIENT_TOKEN",
"in": "header"
}
},
"schemas": {
"RunTestBrowserStatus": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"category": {
"type": "string"
},
"result": {
"type": "string"
},
"state": {
"type": "string"
},
"overridden_results": {
"$ref": "#/components/schemas/OverriddenResult"
},
"credit_cost": {
"type": "string"
}
}
},
"OverriddenResult": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"note": {
"type": "string"
},
"result": {
"type": "string"
},
"job_group_id": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserLite"
}
}
},
"UserLite": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"state": {
"type": "string"
},
"role": {
"type": "string"
}
}
},
"Connection": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"api_token": {
"type": "string"
},
"state": {
"type": "string"
},
"link_state": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"rainforest",
"user"
]
}
},
"description": "Connection model"
},
"Tests_Lite": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"test_id": {
"type": "string"
},
"title": {
"type": "string"
},
"result": {
"type": "string"
},
"wisp": {
"type": "string"
},
"prompt": {
"type": "string"
},
"prompt_credentials": {
"type": "string"
},
"ai_mode": {
"type": "string"
},
"priority": {
"type": "string"
},
"real_cost_to_run": {
"type": "string"
},
"owner_id": {
"type": "string"
},
"state": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"deleted": {
"type": "string"
},
"feature_id": {
"type": "string"
}
}
},
"RunSuperLite": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"state": {
"type": "string"
}
}
},
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "An error message describing what went wrong"
}
},
"required": [
"error"
],
"description": "Error model"
},
"SmartFolder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"filter",
"tag"
]
},
"logic": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"expression": {
"tag": "foo",
"inclusive": true
}
},
{
"operation": "and"
},
{
"expression": {
"tag": "bar",
"inclusive": false
}
},
{
"operation": "or"
},
{
"expression": {
"tag": "baz",
"inclusive": true
}
}
]
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Filter"
},
"example": [
{
"owner_id": 117
},
{
"priority": "P1"
}
]
},
"test_count": {
"type": "integer",
"format": "int32"
},
"tests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tests_Index"
}
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"title",
"type",
"logic",
"filters",
"updated_at"
],
"description": "SmartFolder model"
},
"Filter": {
"type": "object",
"properties": {
"query": {
"type": "string"
},
"step_query": {
"type": "string"
},
"owner_id": {
"type": "integer",
"format": "int32"
},
"result": {
"type": "string",
"enum": [
"passed",
"failed"
]
},
"feature_id": {
"type": "integer",
"format": "int32"
},
"run_group_id": {
"type": "integer",
"format": "int32"
},
"priority": {
"type": "string",
"enum": [
"P1",
"P2",
"P3",
"not_prioritized"
]
},
"embedded": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"enabled",
"disabled",
"draft"
]
},
"site_id": {
"type": "integer",
"format": "int32"
},
"category": {
"type": "string",
"enum": [
"site",
"app"
]
},
"variable": {
"type": "string"
},
"exploratory_run_id": {
"type": "integer",
"format": "int32"
},
"test_language": {
"type": "string",
"enum": [
"plain_english",
"rainforest_test_language"
]
},
"has_comments": {
"type": "boolean"
}
}
},
"Tests_Index": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_at": {
"type": "string"
},
"test_id": {
"type": "string"
},
"title": {
"type": "string"
},
"result": {
"type": "string"
},
"wisp": {
"type": "string"
},
"prompt": {
"type": "string"
},
"prompt_credentials": {
"type": "string"
},
"ai_mode": {
"type": "string"
},
"state": {
"type": "string"
},
"category": {
"type": "string"
},
"site_id": {
"type": "string"
},
"priority": {
"type": "string"
},
"start_uri": {
"type": "string"
},
"description": {
"type": "string"
},
"browsers": {
"$ref": "#/components/schemas/RunTestBrowserStatus"
},
"tags": {
"type": "string"
},
"frontend_url": {
"type": "string"
},
"rfml_id": {
"type": "string"
},
"exploratory_run_id": {
"type": "string"
},
"initial_redirect_behavior": {
"type": "string"
},
"source": {
"type": "string"
},
"reroute_geo": {
"type": "string",
"description": "Deprecated: please use `connection.id` instead"
},
"connection": {
"$ref": "#/components/schemas/Connection"
},
"atc_settings": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/UserLite"
},
"last_updated_by": {
"$ref": "#/components/schemas/UserLite"
},
"updated_at": {
"type": "string"
},
"archived_at": {
"type": "string"
},
"deleted": {
"type": "string"
},
"attached_to": {
"$ref": "#/components/schemas/Tests_Lite"
},
"dry_run_url": {
"type": "string"
},
"last_run": {
"$ref": "#/components/schemas/RunSuperLite"
},
"feature_id": {
"type": "string"
},
"has_wisp": {
"type": "string"
},
"type": {
"type": "string"
},
"coverage_summary": {
"type": "string"
},
"used_in_snippets_count": {
"type": "string"
},
"used_in_tests_count": {
"type": "string"
},
"used_in_archived_snippets_count": {
"type": "string"
},
"used_in_archived_tests_count": {
"type": "string"
},
"self_healed_at": {
"type": "string"
},
"last_run_test": {
"type": "object",
"properties": {
"self_healed": {
"type": "string"
},
"rescued": {
"type": "string"
}
}
}
}
},
"put-folder": {
"type": "object",
"properties": {
"without_tests": {
"type": "boolean",
"description": "Return folder data without tests and test_count"
},
"title": {
"type": "string",
"description": "The title of the folder"
},
"logic": {
"type": "array",
"description": "An array of alternating tag expressions and operations. Must have an odd number of elements.",
"example": [
{
"expression": {
"tag": "foo",
"inclusive": true
}
},
{
"operation": "and"
},
{
"expression": {
"tag": "bar",
"inclusive": false
}
},
{
"operation": "or"
},
{
"expression": {
"tag": "baz",
"inclusive": true
}
}
],
"items": {
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"and",
"or"
]
},
"expression": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "The name of the tag"
},
"inclusive": {
"type": "boolean",
"description": "Whether to filter for tests tagged or untagged with the given tag"
}
},
"required": [
"tag",
"inclusive"
]
}
}
}
},
"filters": {
"type": "array",
"description": "An array of filters. Each filter must have one key. Keys may not be reused across filters.",
"example": [
{
"owner_id": 117
},
{
"priority": "P1"
}
],
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Only select tests with this category",
"enum": [
"app",
"site"
]
},
"exploratory_run_id": {
"type": "integer",
"format": "int32",
"description": "Only select created in this exploratory run"
},
"feature_id": {
"type": "array",
"description": "Only select tests with this/these feature(s); use `-1` to filter for tests without a feature",
"items": {
"type": "integer",
"format": "int32"
}
},
"priority": {
"type": "string",
"description": "Only select tests with this priority",
"enum": [
"P1",
"P2",
"P3",
"",
"not_prioritized"
]
},
"query": {
"type": "string",
"description": "Only select tests whose title contains, or ID matches, this string"
},
"result": {
"type": "string",
"description": "Only select tests with a specific result",
"enum": [
"passed",
"failed",
"no_result"
]
},
"run_group_id": {
"type": "integer",
"format": "int32",
"description": "Only select tests in this run group; use `-1` to filter for tests not in any run groups"
},
"site_id": {
"type": "array",
"description": "Only select tests for this/these site(s)",
"items": {
"type": "integer",
"format": "int32"
}
},
"state": {
"type": "array",
"description": "Only select tests that with this state",
"items": {
"type": "string",
"enum": [
"enabled",
"disabled",
"draft",
"archived",
"all",
"unarchived"
]
}
},
"step_query": {
"type": "string",
"description": "Only select tests whose steps match this string"
},
"tests": {
"type": "string",
"description": "Only select tests matching this criteria. Can be comma-separated list of test ids or 'all' to select all tests"
},
"type": {
"type": "string",
"description": "Only select tests of this type",
"enum": [
"snippet",
"test"
]
},
"run_id": {
"type": "array",
"description": "Only select tests that were in this/these previous run(s)",
"items": {
"type": "integer",
"format": "int32"
}
},
"variable": {
"type": "string",
"description": "Only select tests that contain given variable"
},
"embedded": {
"type": "boolean",
"description": "If true, only select tests that are embedded in other tests. If false, only select tests that are not embedded in other tests."
},
"owner_id": {
"type": "integer",
"format": "int32",
"description": "Only select tests owned by this user; use `-1` to filter for tests without an owner"
},
"test_language": {
"type": "string",
"description": "Only select tests with a specified language",
"enum": [
"plain_english",
"rainforest_test_language"
]
},
"has_comments": {
"type": "string"
}
}
}
}
},
"description": "Update a folder"
}
}
}
}
```