cURL
curl --request POST \
--url https://platform.thena.ai/v1/forms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"fields": [
{
"field": "<string>",
"editableByCustomer": true,
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true
}
],
"isActive": true,
"channels": [
"<string>"
],
"teamId": "<string>"
}
'import requests
url = "https://platform.thena.ai/v1/forms"
payload = {
"name": "<string>",
"description": "<string>",
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [{}]
}
],
"forVendor": True,
"forUser": True,
"teamId": "<string>"
}
],
"fields": [
{
"field": "<string>",
"editableByCustomer": True,
"defaultValue": {},
"mandatoryOnCreation": True,
"mandatoryOnClose": True,
"visibleToCustomer": True
}
],
"isActive": True,
"channels": ["<string>"],
"teamId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
conditions: [
{
triggerFieldId: '<string>',
triggerFieldValue: {},
conditionType: '<string>',
targetFields: [{id: '<string>', type: '<string>', value: {}, options: [{}]}],
forVendor: true,
forUser: true,
teamId: '<string>'
}
],
fields: [
{
field: '<string>',
editableByCustomer: true,
defaultValue: {},
mandatoryOnCreation: true,
mandatoryOnClose: true,
visibleToCustomer: true
}
],
isActive: true,
channels: ['<string>'],
teamId: '<string>'
})
};
fetch('https://platform.thena.ai/v1/forms', 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.thena.ai/v1/forms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'conditions' => [
[
'triggerFieldId' => '<string>',
'triggerFieldValue' => [
],
'conditionType' => '<string>',
'targetFields' => [
[
'id' => '<string>',
'type' => '<string>',
'value' => [
],
'options' => [
[
]
]
]
],
'forVendor' => true,
'forUser' => true,
'teamId' => '<string>'
]
],
'fields' => [
[
'field' => '<string>',
'editableByCustomer' => true,
'defaultValue' => [
],
'mandatoryOnCreation' => true,
'mandatoryOnClose' => true,
'visibleToCustomer' => true
]
],
'isActive' => true,
'channels' => [
'<string>'
],
'teamId' => '<string>'
]),
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://platform.thena.ai/v1/forms"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"conditions\": [\n {\n \"triggerFieldId\": \"<string>\",\n \"triggerFieldValue\": {},\n \"conditionType\": \"<string>\",\n \"targetFields\": [\n {\n \"id\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {},\n \"options\": [\n {}\n ]\n }\n ],\n \"forVendor\": true,\n \"forUser\": true,\n \"teamId\": \"<string>\"\n }\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"editableByCustomer\": true,\n \"defaultValue\": {},\n \"mandatoryOnCreation\": true,\n \"mandatoryOnClose\": true,\n \"visibleToCustomer\": true\n }\n ],\n \"isActive\": true,\n \"channels\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://platform.thena.ai/v1/forms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"conditions\": [\n {\n \"triggerFieldId\": \"<string>\",\n \"triggerFieldValue\": {},\n \"conditionType\": \"<string>\",\n \"targetFields\": [\n {\n \"id\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {},\n \"options\": [\n {}\n ]\n }\n ],\n \"forVendor\": true,\n \"forUser\": true,\n \"teamId\": \"<string>\"\n }\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"editableByCustomer\": true,\n \"defaultValue\": {},\n \"mandatoryOnCreation\": true,\n \"mandatoryOnClose\": true,\n \"visibleToCustomer\": true\n }\n ],\n \"isActive\": true,\n \"channels\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.thena.ai/v1/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"conditions\": [\n {\n \"triggerFieldId\": \"<string>\",\n \"triggerFieldValue\": {},\n \"conditionType\": \"<string>\",\n \"targetFields\": [\n {\n \"id\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {},\n \"options\": [\n {}\n ]\n }\n ],\n \"forVendor\": true,\n \"forUser\": true,\n \"teamId\": \"<string>\"\n }\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"editableByCustomer\": true,\n \"defaultValue\": {},\n \"mandatoryOnCreation\": true,\n \"mandatoryOnClose\": true,\n \"visibleToCustomer\": true\n }\n ],\n \"isActive\": true,\n \"channels\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"fields": [
{
"field": "<string>",
"editableByCustomer": true,
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true
}
],
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"version": 123,
"isActive": true,
"default": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channels": [
"<string>"
],
"teamId": "<string>",
"order": 123
},
"status": true,
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"statusCode": 400,
"message": "User is not a member of this team!",
"error": "Bad Request"
}{
"statusCode": 401,
"message": "User is not authenticated!",
"error": "Unauthorized"
}{
"statusCode": 403,
"message": "User does not have access to this resource!",
"error": "Forbidden"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Team not found!"
}{
"statusCode": 500,
"message": "Something went wrong!",
"error": "Internal Server Error"
}{
"statusCode": 503,
"message": "This service/resource is currently unavailable.",
"error": "Service Unavailable"
}Forms
Create a form
POST
/
v1
/
forms
cURL
curl --request POST \
--url https://platform.thena.ai/v1/forms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"fields": [
{
"field": "<string>",
"editableByCustomer": true,
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true
}
],
"isActive": true,
"channels": [
"<string>"
],
"teamId": "<string>"
}
'import requests
url = "https://platform.thena.ai/v1/forms"
payload = {
"name": "<string>",
"description": "<string>",
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [{}]
}
],
"forVendor": True,
"forUser": True,
"teamId": "<string>"
}
],
"fields": [
{
"field": "<string>",
"editableByCustomer": True,
"defaultValue": {},
"mandatoryOnCreation": True,
"mandatoryOnClose": True,
"visibleToCustomer": True
}
],
"isActive": True,
"channels": ["<string>"],
"teamId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
conditions: [
{
triggerFieldId: '<string>',
triggerFieldValue: {},
conditionType: '<string>',
targetFields: [{id: '<string>', type: '<string>', value: {}, options: [{}]}],
forVendor: true,
forUser: true,
teamId: '<string>'
}
],
fields: [
{
field: '<string>',
editableByCustomer: true,
defaultValue: {},
mandatoryOnCreation: true,
mandatoryOnClose: true,
visibleToCustomer: true
}
],
isActive: true,
channels: ['<string>'],
teamId: '<string>'
})
};
fetch('https://platform.thena.ai/v1/forms', 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.thena.ai/v1/forms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'conditions' => [
[
'triggerFieldId' => '<string>',
'triggerFieldValue' => [
],
'conditionType' => '<string>',
'targetFields' => [
[
'id' => '<string>',
'type' => '<string>',
'value' => [
],
'options' => [
[
]
]
]
],
'forVendor' => true,
'forUser' => true,
'teamId' => '<string>'
]
],
'fields' => [
[
'field' => '<string>',
'editableByCustomer' => true,
'defaultValue' => [
],
'mandatoryOnCreation' => true,
'mandatoryOnClose' => true,
'visibleToCustomer' => true
]
],
'isActive' => true,
'channels' => [
'<string>'
],
'teamId' => '<string>'
]),
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://platform.thena.ai/v1/forms"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"conditions\": [\n {\n \"triggerFieldId\": \"<string>\",\n \"triggerFieldValue\": {},\n \"conditionType\": \"<string>\",\n \"targetFields\": [\n {\n \"id\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {},\n \"options\": [\n {}\n ]\n }\n ],\n \"forVendor\": true,\n \"forUser\": true,\n \"teamId\": \"<string>\"\n }\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"editableByCustomer\": true,\n \"defaultValue\": {},\n \"mandatoryOnCreation\": true,\n \"mandatoryOnClose\": true,\n \"visibleToCustomer\": true\n }\n ],\n \"isActive\": true,\n \"channels\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://platform.thena.ai/v1/forms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"conditions\": [\n {\n \"triggerFieldId\": \"<string>\",\n \"triggerFieldValue\": {},\n \"conditionType\": \"<string>\",\n \"targetFields\": [\n {\n \"id\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {},\n \"options\": [\n {}\n ]\n }\n ],\n \"forVendor\": true,\n \"forUser\": true,\n \"teamId\": \"<string>\"\n }\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"editableByCustomer\": true,\n \"defaultValue\": {},\n \"mandatoryOnCreation\": true,\n \"mandatoryOnClose\": true,\n \"visibleToCustomer\": true\n }\n ],\n \"isActive\": true,\n \"channels\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.thena.ai/v1/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"conditions\": [\n {\n \"triggerFieldId\": \"<string>\",\n \"triggerFieldValue\": {},\n \"conditionType\": \"<string>\",\n \"targetFields\": [\n {\n \"id\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {},\n \"options\": [\n {}\n ]\n }\n ],\n \"forVendor\": true,\n \"forUser\": true,\n \"teamId\": \"<string>\"\n }\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"editableByCustomer\": true,\n \"defaultValue\": {},\n \"mandatoryOnCreation\": true,\n \"mandatoryOnClose\": true,\n \"visibleToCustomer\": true\n }\n ],\n \"isActive\": true,\n \"channels\": [\n \"<string>\"\n ],\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"fields": [
{
"field": "<string>",
"editableByCustomer": true,
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true
}
],
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"version": 123,
"isActive": true,
"default": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"channels": [
"<string>"
],
"teamId": "<string>",
"order": 123
},
"status": true,
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"statusCode": 400,
"message": "User is not a member of this team!",
"error": "Bad Request"
}{
"statusCode": 401,
"message": "User is not authenticated!",
"error": "Unauthorized"
}{
"statusCode": 403,
"message": "User does not have access to this resource!",
"error": "Forbidden"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Team not found!"
}{
"statusCode": 500,
"message": "Something went wrong!",
"error": "Internal Server Error"
}{
"statusCode": 503,
"message": "This service/resource is currently unavailable.",
"error": "Service Unavailable"
}Authorizations
Enter your API key
Body
application/json
The name of the form
The description of the form
Conditions of the form
Show child attributes
Show child attributes
Fields of the form
Show child attributes
Show child attributes
Indicates if the form is active
Channels of the form
The ID of the team
⌘I