Update action
curl --request PATCH \
--url https://api-prod.usefini.com/v2/hc-tools/{id}/public \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"name": "<string>",
"description": "<string>",
"alwaysGet": true,
"inputSchema": [
{}
],
"outputSchema": [
{}
]
}
'import requests
url = "https://api-prod.usefini.com/v2/hc-tools/{id}/public"
payload = {
"name": "<string>",
"description": "<string>",
"alwaysGet": True,
"inputSchema": [{}],
"outputSchema": [{}]
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
alwaysGet: true,
inputSchema: [{}],
outputSchema: [{}]
})
};
fetch('https://api-prod.usefini.com/v2/hc-tools/{id}/public', 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://api-prod.usefini.com/v2/hc-tools/{id}/public",
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([
'name' => '<string>',
'description' => '<string>',
'alwaysGet' => true,
'inputSchema' => [
[
]
],
'outputSchema' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$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://api-prod.usefini.com/v2/hc-tools/{id}/public"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alwaysGet\": true,\n \"inputSchema\": [\n {}\n ],\n \"outputSchema\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-prod.usefini.com/v2/hc-tools/{id}/public")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alwaysGet\": true,\n \"inputSchema\": [\n {}\n ],\n \"outputSchema\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.usefini.com/v2/hc-tools/{id}/public")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alwaysGet\": true,\n \"inputSchema\": [\n {}\n ],\n \"outputSchema\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyActions
Update action
Update an action, including its input and output schema.
PATCH
/
v2
/
hc-tools
/
{id}
/
public
Update action
curl --request PATCH \
--url https://api-prod.usefini.com/v2/hc-tools/{id}/public \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"name": "<string>",
"description": "<string>",
"alwaysGet": true,
"inputSchema": [
{}
],
"outputSchema": [
{}
]
}
'import requests
url = "https://api-prod.usefini.com/v2/hc-tools/{id}/public"
payload = {
"name": "<string>",
"description": "<string>",
"alwaysGet": True,
"inputSchema": [{}],
"outputSchema": [{}]
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
alwaysGet: true,
inputSchema: [{}],
outputSchema: [{}]
})
};
fetch('https://api-prod.usefini.com/v2/hc-tools/{id}/public', 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://api-prod.usefini.com/v2/hc-tools/{id}/public",
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([
'name' => '<string>',
'description' => '<string>',
'alwaysGet' => true,
'inputSchema' => [
[
]
],
'outputSchema' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$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://api-prod.usefini.com/v2/hc-tools/{id}/public"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alwaysGet\": true,\n \"inputSchema\": [\n {}\n ],\n \"outputSchema\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-prod.usefini.com/v2/hc-tools/{id}/public")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alwaysGet\": true,\n \"inputSchema\": [\n {}\n ],\n \"outputSchema\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.usefini.com/v2/hc-tools/{id}/public")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"alwaysGet\": true,\n \"inputSchema\": [\n {}\n ],\n \"outputSchema\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyUpdates one
Action. This is where you set the inputSchema and outputSchema.
An action returns nothing to a rule unless it declares an
outputSchema. Set it here and map each output field to a Data Step response path.Headers
string
required
Bearer token containing your Fini workspace API key. Format:
Bearer fini_... The key needs write scope.string
required
application/jsonPath parameters
string
required
Action ID to update.
Body parameters
All fields are optional. Send only what you want to change.string
Updated display name.
string
Updated description.
boolean
Send
true to convert the action into an attribute.InputSchemaField[]
Typed inputs. See InputSchemaField.
OutputSchemaField[]
Typed outputs. See OutputSchemaField.
Response
Returns the updatedAction / Attribute.
Errors
400 Bad Request
400 Bad Request
The body is malformed.
401 Unauthorized
401 Unauthorized
The API key is missing, malformed, revoked, or invalid.
403 Forbidden
403 Forbidden
The API key does not include the
write scope required for this route.404 Not Found
404 Not Found
No action with that ID exists in your workspace.
500 Internal Server Error
500 Internal Server Error
Fini failed while updating the record in storage.
Was this page helpful?
⌘I

