Update form
curl --request PUT \
--url https://api.octaviatech.app/cms/forms/update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"id": "{{objectId}}",
"title": {
"en": "Contact Us (updated)"
},
"isActive": true
}
'import requests
url = "https://api.octaviatech.app/cms/forms/update"
payload = {
"id": "{{objectId}}",
"title": { "en": "Contact Us (updated)" },
"isActive": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '{{objectId}}', title: {en: 'Contact Us (updated)'}, isActive: true})
};
fetch('https://api.octaviatech.app/cms/forms/update', 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.octaviatech.app/cms/forms/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '{{objectId}}',
'title' => [
'en' => 'Contact Us (updated)'
],
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.octaviatech.app/cms/forms/update"
payload := strings.NewReader("{\n \"id\": \"{{objectId}}\",\n \"title\": {\n \"en\": \"Contact Us (updated)\"\n },\n \"isActive\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.octaviatech.app/cms/forms/update")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"{{objectId}}\",\n \"title\": {\n \"en\": \"Contact Us (updated)\"\n },\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/forms/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"{{objectId}}\",\n \"title\": {\n \"en\": \"Contact Us (updated)\"\n },\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_bodyForms
Update form
Partial update. Provide only the fields to change. ID is required in the body.
PUT
/
forms
/
update
Update form
curl --request PUT \
--url https://api.octaviatech.app/cms/forms/update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"id": "{{objectId}}",
"title": {
"en": "Contact Us (updated)"
},
"isActive": true
}
'import requests
url = "https://api.octaviatech.app/cms/forms/update"
payload = {
"id": "{{objectId}}",
"title": { "en": "Contact Us (updated)" },
"isActive": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '{{objectId}}', title: {en: 'Contact Us (updated)'}, isActive: true})
};
fetch('https://api.octaviatech.app/cms/forms/update', 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.octaviatech.app/cms/forms/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '{{objectId}}',
'title' => [
'en' => 'Contact Us (updated)'
],
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.octaviatech.app/cms/forms/update"
payload := strings.NewReader("{\n \"id\": \"{{objectId}}\",\n \"title\": {\n \"en\": \"Contact Us (updated)\"\n },\n \"isActive\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.octaviatech.app/cms/forms/update")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"{{objectId}}\",\n \"title\": {\n \"en\": \"Contact Us (updated)\"\n },\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/forms/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"{{objectId}}\",\n \"title\": {\n \"en\": \"Contact Us (updated)\"\n },\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Body
application/json
24-char hex identifier of the form.
Pattern:
^[a-fA-F0-9]{24}$Show child attributes
Show child attributes
Must satisfy slug rules and remain unique per tenant.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Sections may include field-level relation definitions identical to the create payload.
Same values as on create.
Available options:
public, internal Per-form CAPTCHA gate; same shape as on create.
Show child attributes
Show child attributes
Submission notification settings; same shape as on create.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Updated
Was this page helpful?

