Program Forms
Edit a form field
Edit an existing field in a form
PUT
/
admin
/
form
/
field
Edit a form field
curl --request PUT \
--url https://api.helpyousponsor.com/v1/admin/form/field \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"id": 123,
"client_id": "<string>",
"hysform_id": 123,
"field_key": "<string>",
"field_label": "<string>",
"field_data": "<string>",
"field_type": "<string>",
"required": true,
"permissions": "<string>",
"admingroup_id": 123,
"is_title": true,
"sortable": 123,
"filter": 123,
"field_order": 123,
"deleted_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"type": "<string>"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/form/field"
payload = {
"id": 123,
"client_id": "<string>",
"hysform_id": 123,
"field_key": "<string>",
"field_label": "<string>",
"field_data": "<string>",
"field_type": "<string>",
"required": True,
"permissions": "<string>",
"admingroup_id": 123,
"is_title": True,
"sortable": 123,
"filter": 123,
"field_order": 123,
"deleted_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"type": "<string>"
}
headers = {
"X-HYS-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-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 123,
client_id: '<string>',
hysform_id: 123,
field_key: '<string>',
field_label: '<string>',
field_data: '<string>',
field_type: '<string>',
required: true,
permissions: '<string>',
admingroup_id: 123,
is_title: true,
sortable: 123,
filter: 123,
field_order: 123,
deleted_at: '<string>',
created_at: '<string>',
updated_at: '<string>',
type: '<string>'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/form/field', 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.helpyousponsor.com/v1/admin/form/field",
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' => 123,
'client_id' => '<string>',
'hysform_id' => 123,
'field_key' => '<string>',
'field_label' => '<string>',
'field_data' => '<string>',
'field_type' => '<string>',
'required' => true,
'permissions' => '<string>',
'admingroup_id' => 123,
'is_title' => true,
'sortable' => 123,
'filter' => 123,
'field_order' => 123,
'deleted_at' => '<string>',
'created_at' => '<string>',
'updated_at' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-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.helpyousponsor.com/v1/admin/form/field"
payload := strings.NewReader("{\n \"id\": 123,\n \"client_id\": \"<string>\",\n \"hysform_id\": 123,\n \"field_key\": \"<string>\",\n \"field_label\": \"<string>\",\n \"field_data\": \"<string>\",\n \"field_type\": \"<string>\",\n \"required\": true,\n \"permissions\": \"<string>\",\n \"admingroup_id\": 123,\n \"is_title\": true,\n \"sortable\": 123,\n \"filter\": 123,\n \"field_order\": 123,\n \"deleted_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-HYS-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.helpyousponsor.com/v1/admin/form/field")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123,\n \"client_id\": \"<string>\",\n \"hysform_id\": 123,\n \"field_key\": \"<string>\",\n \"field_label\": \"<string>\",\n \"field_data\": \"<string>\",\n \"field_type\": \"<string>\",\n \"required\": true,\n \"permissions\": \"<string>\",\n \"admingroup_id\": 123,\n \"is_title\": true,\n \"sortable\": 123,\n \"filter\": 123,\n \"field_order\": 123,\n \"deleted_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/form/field")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 123,\n \"client_id\": \"<string>\",\n \"hysform_id\": 123,\n \"field_key\": \"<string>\",\n \"field_label\": \"<string>\",\n \"field_data\": \"<string>\",\n \"field_type\": \"<string>\",\n \"required\": true,\n \"permissions\": \"<string>\",\n \"admingroup_id\": 123,\n \"is_title\": true,\n \"sortable\": 123,\n \"filter\": 123,\n \"field_order\": 123,\n \"deleted_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Field data to be updated
Response
Successful operation
⌘I
Edit a form field
curl --request PUT \
--url https://api.helpyousponsor.com/v1/admin/form/field \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"id": 123,
"client_id": "<string>",
"hysform_id": 123,
"field_key": "<string>",
"field_label": "<string>",
"field_data": "<string>",
"field_type": "<string>",
"required": true,
"permissions": "<string>",
"admingroup_id": 123,
"is_title": true,
"sortable": 123,
"filter": 123,
"field_order": 123,
"deleted_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"type": "<string>"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/form/field"
payload = {
"id": 123,
"client_id": "<string>",
"hysform_id": 123,
"field_key": "<string>",
"field_label": "<string>",
"field_data": "<string>",
"field_type": "<string>",
"required": True,
"permissions": "<string>",
"admingroup_id": 123,
"is_title": True,
"sortable": 123,
"filter": 123,
"field_order": 123,
"deleted_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"type": "<string>"
}
headers = {
"X-HYS-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-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 123,
client_id: '<string>',
hysform_id: 123,
field_key: '<string>',
field_label: '<string>',
field_data: '<string>',
field_type: '<string>',
required: true,
permissions: '<string>',
admingroup_id: 123,
is_title: true,
sortable: 123,
filter: 123,
field_order: 123,
deleted_at: '<string>',
created_at: '<string>',
updated_at: '<string>',
type: '<string>'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/form/field', 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.helpyousponsor.com/v1/admin/form/field",
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' => 123,
'client_id' => '<string>',
'hysform_id' => 123,
'field_key' => '<string>',
'field_label' => '<string>',
'field_data' => '<string>',
'field_type' => '<string>',
'required' => true,
'permissions' => '<string>',
'admingroup_id' => 123,
'is_title' => true,
'sortable' => 123,
'filter' => 123,
'field_order' => 123,
'deleted_at' => '<string>',
'created_at' => '<string>',
'updated_at' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-HYS-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.helpyousponsor.com/v1/admin/form/field"
payload := strings.NewReader("{\n \"id\": 123,\n \"client_id\": \"<string>\",\n \"hysform_id\": 123,\n \"field_key\": \"<string>\",\n \"field_label\": \"<string>\",\n \"field_data\": \"<string>\",\n \"field_type\": \"<string>\",\n \"required\": true,\n \"permissions\": \"<string>\",\n \"admingroup_id\": 123,\n \"is_title\": true,\n \"sortable\": 123,\n \"filter\": 123,\n \"field_order\": 123,\n \"deleted_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-HYS-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.helpyousponsor.com/v1/admin/form/field")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 123,\n \"client_id\": \"<string>\",\n \"hysform_id\": 123,\n \"field_key\": \"<string>\",\n \"field_label\": \"<string>\",\n \"field_data\": \"<string>\",\n \"field_type\": \"<string>\",\n \"required\": true,\n \"permissions\": \"<string>\",\n \"admingroup_id\": 123,\n \"is_title\": true,\n \"sortable\": 123,\n \"filter\": 123,\n \"field_order\": 123,\n \"deleted_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/form/field")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": 123,\n \"client_id\": \"<string>\",\n \"hysform_id\": 123,\n \"field_key\": \"<string>\",\n \"field_label\": \"<string>\",\n \"field_data\": \"<string>\",\n \"field_type\": \"<string>\",\n \"required\": true,\n \"permissions\": \"<string>\",\n \"admingroup_id\": 123,\n \"is_title\": true,\n \"sortable\": 123,\n \"filter\": 123,\n \"field_order\": 123,\n \"deleted_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"message": "<string>"
}
