Set action availability
Requires actions:write. Prefer mode=off (unavailable), playground (Playground only), or active (live and Playground). Never combine mode with active/playgroundOnly/allowInPlayground. Legacy switches remain accepted; old HTTP live-only configurations read as legacy_live_only until explicitly changed. Collection and Sheets require current revision; HTTP has no revision. Availability is separate from draft publication, business scope and HTTP test consent. Versioned families preserve immutable versions; unsupported switches are rejected.
curl --request PATCH \
--url https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"revision": 2,
"playgroundOnly": true,
"allowInPlayground": true
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state"
payload = {
"active": True,
"revision": 2,
"playgroundOnly": True,
"allowInPlayground": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({active: true, revision: 2, playgroundOnly: true, allowInPlayground: true})
};
fetch('https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state', 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://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'active' => true,
'revision' => 2,
'playgroundOnly' => true,
'allowInPlayground' => true
]),
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://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state"
payload := strings.NewReader("{\n \"active\": true,\n \"revision\": 2,\n \"playgroundOnly\": true,\n \"allowInPlayground\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"revision\": 2,\n \"playgroundOnly\": true,\n \"allowInPlayground\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"revision\": 2,\n \"playgroundOnly\": true,\n \"allowInPlayground\": true\n}"
response = http.request(request)
puts response.read_body{
"action": {
"actionId": "<string>",
"family": "http",
"revision": 2,
"supportedOperations": [
"configuration"
],
"state": {
"active": true,
"playgroundOnly": true,
"status": "draft",
"allowInPlayground": true,
"mode": "off"
},
"configuration": {
"toolId": "<string>",
"tenantId": "<string>",
"name": "<string>",
"description": "<string>",
"parameters": {},
"endpoint": {
"url": "<string>",
"method": "GET",
"timeoutMs": 15250
},
"auth": {
"type": "none",
"configured": true,
"headerName": "<string>",
"secretLastFour": "<string>"
},
"active": true,
"readOnly": true,
"allowInPlayground": true,
"propertyIds": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"mode": "off",
"playgroundOnly": true,
"configurationVersion": "<string>",
"scopeMode": "tenant"
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}Autorizaciones
Server-side tenant-scoped credential created from Build > API Keys.
Parámetros de ruta
Cuerpo
- Option 1
- Option 2
- Option 3
- Option 4
x >= 1off: unavailable; playground: Playground only; active: live channels and Playground. Do not combine mode with legacy state fields.
off, playground, active Respuesta
Successful action operation
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
curl --request PATCH \
--url https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"revision": 2,
"playgroundOnly": true,
"allowInPlayground": true
}
'import requests
url = "https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state"
payload = {
"active": True,
"revision": 2,
"playgroundOnly": True,
"allowInPlayground": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({active: true, revision: 2, playgroundOnly: true, allowInPlayground: true})
};
fetch('https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state', 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://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'active' => true,
'revision' => 2,
'playgroundOnly' => true,
'allowInPlayground' => true
]),
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://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state"
payload := strings.NewReader("{\n \"active\": true,\n \"revision\": 2,\n \"playgroundOnly\": true,\n \"allowInPlayground\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"revision\": 2,\n \"playgroundOnly\": true,\n \"allowInPlayground\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/actions/{actionId}/state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"revision\": 2,\n \"playgroundOnly\": true,\n \"allowInPlayground\": true\n}"
response = http.request(request)
puts response.read_body{
"action": {
"actionId": "<string>",
"family": "http",
"revision": 2,
"supportedOperations": [
"configuration"
],
"state": {
"active": true,
"playgroundOnly": true,
"status": "draft",
"allowInPlayground": true,
"mode": "off"
},
"configuration": {
"toolId": "<string>",
"tenantId": "<string>",
"name": "<string>",
"description": "<string>",
"parameters": {},
"endpoint": {
"url": "<string>",
"method": "GET",
"timeoutMs": 15250
},
"auth": {
"type": "none",
"configured": true,
"headerName": "<string>",
"secretLastFour": "<string>"
},
"active": true,
"readOnly": true,
"allowInPlayground": true,
"propertyIds": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"mode": "off",
"playgroundOnly": true,
"configurationVersion": "<string>",
"scopeMode": "tenant"
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}