Set tool active status
curl --request PATCH \
--url https://flowra.dev/api/v1/tools/byId/{id}/status \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/tools/byId/{id}/status"
headers = {"x-api-key": "<api-key>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};
fetch('https://flowra.dev/api/v1/tools/byId/{id}/status', 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://flowra.dev/api/v1/tools/byId/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/tools/byId/{id}/status"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://flowra.dev/api/v1/tools/byId/{id}/status")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/tools/byId/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"slug": "gmail_send_email",
"name": "Send Email",
"description": "Sends an email via Gmail",
"instructions": "Use when the user asks to send an email.",
"toolkitSlug": "gmail",
"inputParameters": {
"type": "object",
"properties": {
"to": {
"type": "string"
}
}
},
"outputParameters": {
"type": "object",
"properties": {
"messageId": {
"type": "string"
}
}
},
"noAuth": false,
"availableVersions": [
"1.0.0"
],
"version": "1.0.0",
"scopes": [
"gmail.send"
],
"tags": [
"email"
],
"isImportant": false,
"isDeprecated": false,
"isDisabled": false,
"popularityScore": 12,
"provider": "COMPOSIO",
"type": "action",
"ragContentHash": "",
"ragSyncedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"fieldModifiers": {},
"script": "javascript",
"executionCreditCost": 0
}
}Tools
Set tool active status
Enable or disable a tool without deleting it. Disabled tools cannot be executed or selected in workflows.
PATCH
/
api
/
v1
/
tools
/
byId
/
{id}
/
status
Set tool active status
curl --request PATCH \
--url https://flowra.dev/api/v1/tools/byId/{id}/status \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/tools/byId/{id}/status"
headers = {"x-api-key": "<api-key>"}
response = requests.patch(url, headers=headers)
print(response.text)const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};
fetch('https://flowra.dev/api/v1/tools/byId/{id}/status', 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://flowra.dev/api/v1/tools/byId/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/tools/byId/{id}/status"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://flowra.dev/api/v1/tools/byId/{id}/status")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/tools/byId/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"slug": "gmail_send_email",
"name": "Send Email",
"description": "Sends an email via Gmail",
"instructions": "Use when the user asks to send an email.",
"toolkitSlug": "gmail",
"inputParameters": {
"type": "object",
"properties": {
"to": {
"type": "string"
}
}
},
"outputParameters": {
"type": "object",
"properties": {
"messageId": {
"type": "string"
}
}
},
"noAuth": false,
"availableVersions": [
"1.0.0"
],
"version": "1.0.0",
"scopes": [
"gmail.send"
],
"tags": [
"email"
],
"isImportant": false,
"isDeprecated": false,
"isDisabled": false,
"popularityScore": 12,
"provider": "COMPOSIO",
"type": "action",
"ragContentHash": "",
"ragSyncedAt": "2024-01-01T00:00:00.000Z",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"fieldModifiers": {},
"script": "javascript",
"executionCreditCost": 0
}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Path Parameters
Tool ID
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Response
200 - application/json
Tool status updated successfully
Success status
Example:
true
Success message
Example:
"Operation completed successfully"
Show child attributes
Show child attributes
Example:
{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "slug": "gmail_send_email", "name": "Send Email", "description": "Sends an email via Gmail", "instructions": "Use when the user asks to send an email.", "toolkitSlug": "gmail", "inputParameters": { "type": "object", "properties": { "to": { "type": "string" } } }, "outputParameters": { "type": "object", "properties": { "messageId": { "type": "string" } } }, "noAuth": false, "availableVersions": ["1.0.0"], "version": "1.0.0", "scopes": ["gmail.send"], "tags": ["email"], "isImportant": false, "isDeprecated": false, "isDisabled": false, "popularityScore": 12, "provider": "COMPOSIO", "type": "action", "ragContentHash": "", "ragSyncedAt": "2024-01-01T00:00:00.000Z", "createdAt": "2024-01-01T00:00:00.000Z", "updatedAt": "2024-01-01T00:00:00.000Z", "fieldModifiers": {}, "script": "javascript", "executionCreditCost": 0 }
Was this page helpful?