Add Question
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/questions \
--header 'Content-Type: application/json' \
--data '
{
"handle": "<string>",
"label": "<string>",
"name": "<string>",
"description": "<string>",
"is_system": true,
"is_active": true,
"meta": [
"<string>"
],
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"validation": [
"<string>"
],
"default_value": "<string>",
"live_from": "2023-11-07T05:31:56Z",
"live_to": "2023-11-07T05:31:56Z",
"answer_ttl_days": 2,
"link_target": "<string>",
"link_write_policy": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>",
"image": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/questions"
payload = {
"handle": "<string>",
"label": "<string>",
"name": "<string>",
"description": "<string>",
"is_system": True,
"is_active": True,
"meta": ["<string>"],
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"validation": ["<string>"],
"default_value": "<string>",
"live_from": "2023-11-07T05:31:56Z",
"live_to": "2023-11-07T05:31:56Z",
"answer_ttl_days": 2,
"link_target": "<string>",
"link_write_policy": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>",
"image": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
handle: '<string>',
label: '<string>',
name: '<string>',
description: '<string>',
is_system: true,
is_active: true,
meta: ['<string>'],
help_text: '<string>',
icon: '<string>',
image_url: '<string>',
validation: ['<string>'],
default_value: '<string>',
live_from: '2023-11-07T05:31:56Z',
live_to: '2023-11-07T05:31:56Z',
answer_ttl_days: 2,
link_target: '<string>',
link_write_policy: '<string>',
options: [{value: '<string>', label: '<string>', image: '<string>'}]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/questions', 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.{tenant}.getomneo.com/api/v3/questions",
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([
'handle' => '<string>',
'label' => '<string>',
'name' => '<string>',
'description' => '<string>',
'is_system' => true,
'is_active' => true,
'meta' => [
'<string>'
],
'help_text' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'validation' => [
'<string>'
],
'default_value' => '<string>',
'live_from' => '2023-11-07T05:31:56Z',
'live_to' => '2023-11-07T05:31:56Z',
'answer_ttl_days' => 2,
'link_target' => '<string>',
'link_write_policy' => '<string>',
'options' => [
[
'value' => '<string>',
'label' => '<string>',
'image' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.{tenant}.getomneo.com/api/v3/questions"
payload := strings.NewReader("{\n \"handle\": \"<string>\",\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_system\": true,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"help_text\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"validation\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"live_from\": \"2023-11-07T05:31:56Z\",\n \"live_to\": \"2023-11-07T05:31:56Z\",\n \"answer_ttl_days\": 2,\n \"link_target\": \"<string>\",\n \"link_write_policy\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"image\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.{tenant}.getomneo.com/api/v3/questions")
.header("Content-Type", "application/json")
.body("{\n \"handle\": \"<string>\",\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_system\": true,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"help_text\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"validation\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"live_from\": \"2023-11-07T05:31:56Z\",\n \"live_to\": \"2023-11-07T05:31:56Z\",\n \"answer_ttl_days\": 2,\n \"link_target\": \"<string>\",\n \"link_write_policy\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"image\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/questions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"handle\": \"<string>\",\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_system\": true,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"help_text\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"validation\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"live_from\": \"2023-11-07T05:31:56Z\",\n \"live_to\": \"2023-11-07T05:31:56Z\",\n \"answer_ttl_days\": 2,\n \"link_target\": \"<string>\",\n \"link_write_policy\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"image\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"is_system": true,
"is_active": true,
"meta": [
"<unknown>"
],
"link_type": "<string>",
"link_target": "<string>",
"link_write_policy": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_live": true,
"current_version": {
"id": 123,
"question_id": 123,
"version": 123,
"label": "<string>",
"description": "<string>",
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"type": "<string>",
"options": [
"<unknown>"
],
"validation": [
"<unknown>"
],
"default_value": [
"<unknown>"
],
"live_from": "<string>",
"live_to": "<string>",
"answer_ttl_days": 123,
"created_at": "<string>",
"updated_at": "<string>"
},
"versions": [
{
"id": 123,
"question_id": 123,
"version": 123,
"label": "<string>",
"description": "<string>",
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"type": "<string>",
"options": [
"<unknown>"
],
"validation": [
"<unknown>"
],
"default_value": [
"<unknown>"
],
"live_from": "<string>",
"live_to": "<string>",
"answer_ttl_days": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Question
Add Question
A POST to the /questions endpoint allows your application to create a question record.
POST
/
v3
/
questions
Add Question
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/questions \
--header 'Content-Type: application/json' \
--data '
{
"handle": "<string>",
"label": "<string>",
"name": "<string>",
"description": "<string>",
"is_system": true,
"is_active": true,
"meta": [
"<string>"
],
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"validation": [
"<string>"
],
"default_value": "<string>",
"live_from": "2023-11-07T05:31:56Z",
"live_to": "2023-11-07T05:31:56Z",
"answer_ttl_days": 2,
"link_target": "<string>",
"link_write_policy": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>",
"image": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/questions"
payload = {
"handle": "<string>",
"label": "<string>",
"name": "<string>",
"description": "<string>",
"is_system": True,
"is_active": True,
"meta": ["<string>"],
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"validation": ["<string>"],
"default_value": "<string>",
"live_from": "2023-11-07T05:31:56Z",
"live_to": "2023-11-07T05:31:56Z",
"answer_ttl_days": 2,
"link_target": "<string>",
"link_write_policy": "<string>",
"options": [
{
"value": "<string>",
"label": "<string>",
"image": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
handle: '<string>',
label: '<string>',
name: '<string>',
description: '<string>',
is_system: true,
is_active: true,
meta: ['<string>'],
help_text: '<string>',
icon: '<string>',
image_url: '<string>',
validation: ['<string>'],
default_value: '<string>',
live_from: '2023-11-07T05:31:56Z',
live_to: '2023-11-07T05:31:56Z',
answer_ttl_days: 2,
link_target: '<string>',
link_write_policy: '<string>',
options: [{value: '<string>', label: '<string>', image: '<string>'}]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/questions', 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.{tenant}.getomneo.com/api/v3/questions",
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([
'handle' => '<string>',
'label' => '<string>',
'name' => '<string>',
'description' => '<string>',
'is_system' => true,
'is_active' => true,
'meta' => [
'<string>'
],
'help_text' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'validation' => [
'<string>'
],
'default_value' => '<string>',
'live_from' => '2023-11-07T05:31:56Z',
'live_to' => '2023-11-07T05:31:56Z',
'answer_ttl_days' => 2,
'link_target' => '<string>',
'link_write_policy' => '<string>',
'options' => [
[
'value' => '<string>',
'label' => '<string>',
'image' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.{tenant}.getomneo.com/api/v3/questions"
payload := strings.NewReader("{\n \"handle\": \"<string>\",\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_system\": true,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"help_text\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"validation\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"live_from\": \"2023-11-07T05:31:56Z\",\n \"live_to\": \"2023-11-07T05:31:56Z\",\n \"answer_ttl_days\": 2,\n \"link_target\": \"<string>\",\n \"link_write_policy\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"image\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.{tenant}.getomneo.com/api/v3/questions")
.header("Content-Type", "application/json")
.body("{\n \"handle\": \"<string>\",\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_system\": true,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"help_text\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"validation\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"live_from\": \"2023-11-07T05:31:56Z\",\n \"live_to\": \"2023-11-07T05:31:56Z\",\n \"answer_ttl_days\": 2,\n \"link_target\": \"<string>\",\n \"link_write_policy\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"image\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/questions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"handle\": \"<string>\",\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"is_system\": true,\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"help_text\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"validation\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"live_from\": \"2023-11-07T05:31:56Z\",\n \"live_to\": \"2023-11-07T05:31:56Z\",\n \"answer_ttl_days\": 2,\n \"link_target\": \"<string>\",\n \"link_write_policy\": \"<string>\",\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"image\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"is_system": true,
"is_active": true,
"meta": [
"<unknown>"
],
"link_type": "<string>",
"link_target": "<string>",
"link_write_policy": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_live": true,
"current_version": {
"id": 123,
"question_id": 123,
"version": 123,
"label": "<string>",
"description": "<string>",
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"type": "<string>",
"options": [
"<unknown>"
],
"validation": [
"<unknown>"
],
"default_value": [
"<unknown>"
],
"live_from": "<string>",
"live_to": "<string>",
"answer_ttl_days": 123,
"created_at": "<string>",
"updated_at": "<string>"
},
"versions": [
{
"id": 123,
"question_id": 123,
"version": 123,
"label": "<string>",
"description": "<string>",
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"type": "<string>",
"options": [
"<unknown>"
],
"validation": [
"<unknown>"
],
"default_value": [
"<unknown>"
],
"live_from": "<string>",
"live_to": "<string>",
"answer_ttl_days": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Maximum string length:
255Maximum string length:
255Available options:
text, textarea, number, slider, boolean, single_select, multi_select, date, datetime, email, phone, json Maximum string length:
255Maximum string length:
255Maximum string length:
2048Required range:
x >= 1Available options:
none, profile, transaction, rating, interaction, appointment, connection, transaction_item Maximum string length:
255Maximum string length:
255Show child attributes
Show child attributes
Response
Question
Show child attributes
Show child attributes
⌘I