Toggle external user active status
curl --request PUT \
--url https://flowra.dev/api/v1/external-users/{id}/toggle-active \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/external-users/{id}/toggle-active"
headers = {"x-api-key": "<api-key>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {'x-api-key': '<api-key>'}};
fetch('https://flowra.dev/api/v1/external-users/{id}/toggle-active', 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/external-users/{id}/toggle-active",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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/external-users/{id}/toggle-active"
req, _ := http.NewRequest("PUT", 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.put("https://flowra.dev/api/v1/external-users/{id}/toggle-active")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/external-users/{id}/toggle-active")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"source": "project_default",
"isActive": true,
"channel": "",
"profileSummary": "",
"avatarUrl": "",
"creditsUsed": 0,
"createdAt": "",
"lastSeenAt": "",
"isOnline": true,
"resourceStats": {
"agentCount": 0,
"workflowCount": 0,
"knowledgeStorageKb": 0,
"databaseStorageKb": 0,
"storageUsedKb": 0,
"connectionCount": 0
},
"addedByWorkflowIds": [
""
],
"addedByWorkflowId": "",
"metadata": {
"channel": "telegram",
"toolkitSlug": "telegram",
"toolSlug": "TELEGRAM_SET_WEBHOOK",
"threadKey": "123456789",
"profile": {
"userId": 123456789,
"username": "amin",
"firstName": "Amin"
},
"updatedAt": "2026-07-13T08:00:00.000Z"
},
"verifiedEmail": "",
"verifiedPhone": "",
"identitySources": [
"email",
"host_sub"
]
}
}External Users
Toggle external user active status
Enable or disable an external user. Project default users cannot be deactivated. Inactive users cannot resolve via x-username or channels.
PUT
/
api
/
v1
/
external-users
/
{id}
/
toggle-active
Toggle external user active status
curl --request PUT \
--url https://flowra.dev/api/v1/external-users/{id}/toggle-active \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/external-users/{id}/toggle-active"
headers = {"x-api-key": "<api-key>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {'x-api-key': '<api-key>'}};
fetch('https://flowra.dev/api/v1/external-users/{id}/toggle-active', 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/external-users/{id}/toggle-active",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
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/external-users/{id}/toggle-active"
req, _ := http.NewRequest("PUT", 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.put("https://flowra.dev/api/v1/external-users/{id}/toggle-active")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/external-users/{id}/toggle-active")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe",
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"source": "project_default",
"isActive": true,
"channel": "",
"profileSummary": "",
"avatarUrl": "",
"creditsUsed": 0,
"createdAt": "",
"lastSeenAt": "",
"isOnline": true,
"resourceStats": {
"agentCount": 0,
"workflowCount": 0,
"knowledgeStorageKb": 0,
"databaseStorageKb": 0,
"storageUsedKb": 0,
"connectionCount": 0
},
"addedByWorkflowIds": [
""
],
"addedByWorkflowId": "",
"metadata": {
"channel": "telegram",
"toolkitSlug": "telegram",
"toolSlug": "TELEGRAM_SET_WEBHOOK",
"threadKey": "123456789",
"profile": {
"userId": 123456789,
"username": "amin",
"firstName": "Amin"
},
"updatedAt": "2026-07-13T08:00:00.000Z"
},
"verifiedEmail": "",
"verifiedPhone": "",
"identitySources": [
"email",
"host_sub"
]
}
}Authorizations
x-api-keyx-api-key & x-username
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.
Path Parameters
External user ID
Example:
"uuid"
Response
200 - application/json
External user active status updated
Success status
Example:
true
Success message
Example:
"Operation completed successfully"
Show child attributes
Show child attributes
Example:
{ "id": "123e4567-e89b-12d3-a456-426614174000", "name": "John Doe", "projectId": "123e4567-e89b-12d3-a456-426614174000", "source": "project_default", "isActive": true, "channel": "", "profileSummary": "", "avatarUrl": "", "creditsUsed": 0, "createdAt": "", "lastSeenAt": "", "isOnline": true, "resourceStats": { "agentCount": 0, "workflowCount": 0, "knowledgeStorageKb": 0, "databaseStorageKb": 0, "storageUsedKb": 0, "connectionCount": 0 }, "addedByWorkflowIds": [""], "addedByWorkflowId": "", "metadata": { "channel": "telegram", "toolkitSlug": "telegram", "toolSlug": "TELEGRAM_SET_WEBHOOK", "threadKey": "123456789", "profile": { "userId": 123456789, "username": "amin", "firstName": "Amin" }, "updatedAt": "2026-07-13T08:00:00.000Z" }, "verifiedEmail": "", "verifiedPhone": "", "identitySources": ["email", "host_sub"] }
Was this page helpful?