Add a form field
curl --request POST \
--url https://api.heffl.com/api/v2/forms/{id}/fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"description": "<string>",
"required": true,
"placeholder": "<string>",
"values": [
"<string>"
],
"settings": {}
}
'import requests
url = "https://api.heffl.com/api/v2/forms/{id}/fields"
payload = {
"label": "<string>",
"description": "<string>",
"required": True,
"placeholder": "<string>",
"values": ["<string>"],
"settings": {}
}
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({
label: '<string>',
description: '<string>',
required: true,
placeholder: '<string>',
values: ['<string>'],
settings: {}
})
};
fetch('https://api.heffl.com/api/v2/forms/{id}/fields', 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.heffl.com/api/v2/forms/{id}/fields",
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([
'label' => '<string>',
'description' => '<string>',
'required' => true,
'placeholder' => '<string>',
'values' => [
'<string>'
],
'settings' => [
]
]),
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.heffl.com/api/v2/forms/{id}/fields"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"settings\": {}\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://api.heffl.com/api/v2/forms/{id}/fields")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/forms/{id}/fields")
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 \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"formId": "<string>",
"formTitle": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"dataType": "<string>",
"required": true,
"type": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"multiple": true
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Forms
Add a form field
Adds a question to a form (on its first page). SINGLE_OPTION / MULTIPLE_OPTION fields require a non-empty values list of allowed options. Returns the updated field list.
POST
/
forms
/
{id}
/
fields
Add a form field
curl --request POST \
--url https://api.heffl.com/api/v2/forms/{id}/fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"label": "<string>",
"description": "<string>",
"required": true,
"placeholder": "<string>",
"values": [
"<string>"
],
"settings": {}
}
'import requests
url = "https://api.heffl.com/api/v2/forms/{id}/fields"
payload = {
"label": "<string>",
"description": "<string>",
"required": True,
"placeholder": "<string>",
"values": ["<string>"],
"settings": {}
}
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({
label: '<string>',
description: '<string>',
required: true,
placeholder: '<string>',
values: ['<string>'],
settings: {}
})
};
fetch('https://api.heffl.com/api/v2/forms/{id}/fields', 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.heffl.com/api/v2/forms/{id}/fields",
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([
'label' => '<string>',
'description' => '<string>',
'required' => true,
'placeholder' => '<string>',
'values' => [
'<string>'
],
'settings' => [
]
]),
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.heffl.com/api/v2/forms/{id}/fields"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"settings\": {}\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://api.heffl.com/api/v2/forms/{id}/fields")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heffl.com/api/v2/forms/{id}/fields")
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 \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"placeholder\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"formId": "<string>",
"formTitle": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"dataType": "<string>",
"required": true,
"type": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"multiple": true
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
API key for authentication. Get yours at app.heffl.com/settings/developers
Path Parameters
Form ID (frm_ prefix)
Body
application/json
Question label shown to respondents
Field data type. SINGLE_OPTION / MULTIPLE_OPTION require values.
Available options:
TEXT, LONG_TEXT, EMAIL, MOBILE, NUMBER, DATE, SINGLE_OPTION, MULTIPLE_OPTION, FILE_PICKER, SIGNATURE, CURRENCY, LINK, RATING, OPINION_SCALE Optional help text under the question
Whether an answer is required. Defaults to false.
Optional input placeholder
Allowed options. Required (non-empty) for SINGLE_OPTION and MULTIPLE_OPTION fields.
Extra config for RATING / OPINION_SCALE fields (e.g. { max: 5 }).
⌘I