Entities
Post Edit Entity
Handles the submission of edited entity data,
- including updating various fields and maintaining archival status if applicable.
PUT
/
admin
/
program
/
entity
Post Edit Entity
curl --request PUT \
--url https://api.helpyousponsor.com/v1/admin/program/entity \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"entity_id": 123,
"en_child_name": "<string>",
"en_gender": "<string>",
"en_grade": "<string>",
"en_age": "<string>",
"en_birthdate": "<string>",
"en_favorite_subject": "<string>",
"en_test_check_box": "<string>",
"en_test_field_boolea": "<string>",
"en_test_checkbox_2": "<string>",
"client_id": "<string>",
"program_id": 123,
"status": "<string>",
"re_add": "<string>",
"sp_amount": "<string>",
"sp_num": "<string>",
"wait_time": "<string>",
"json_fields": "<string>"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/program/entity"
payload = {
"entity_id": 123,
"en_child_name": "<string>",
"en_gender": "<string>",
"en_grade": "<string>",
"en_age": "<string>",
"en_birthdate": "<string>",
"en_favorite_subject": "<string>",
"en_test_check_box": "<string>",
"en_test_field_boolea": "<string>",
"en_test_checkbox_2": "<string>",
"client_id": "<string>",
"program_id": 123,
"status": "<string>",
"re_add": "<string>",
"sp_amount": "<string>",
"sp_num": "<string>",
"wait_time": "<string>",
"json_fields": "<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({
entity_id: 123,
en_child_name: '<string>',
en_gender: '<string>',
en_grade: '<string>',
en_age: '<string>',
en_birthdate: '<string>',
en_favorite_subject: '<string>',
en_test_check_box: '<string>',
en_test_field_boolea: '<string>',
en_test_checkbox_2: '<string>',
client_id: '<string>',
program_id: 123,
status: '<string>',
re_add: '<string>',
sp_amount: '<string>',
sp_num: '<string>',
wait_time: '<string>',
json_fields: '<string>'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/program/entity', 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/program/entity",
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([
'entity_id' => 123,
'en_child_name' => '<string>',
'en_gender' => '<string>',
'en_grade' => '<string>',
'en_age' => '<string>',
'en_birthdate' => '<string>',
'en_favorite_subject' => '<string>',
'en_test_check_box' => '<string>',
'en_test_field_boolea' => '<string>',
'en_test_checkbox_2' => '<string>',
'client_id' => '<string>',
'program_id' => 123,
'status' => '<string>',
're_add' => '<string>',
'sp_amount' => '<string>',
'sp_num' => '<string>',
'wait_time' => '<string>',
'json_fields' => '<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/program/entity"
payload := strings.NewReader("{\n \"entity_id\": 123,\n \"en_child_name\": \"<string>\",\n \"en_gender\": \"<string>\",\n \"en_grade\": \"<string>\",\n \"en_age\": \"<string>\",\n \"en_birthdate\": \"<string>\",\n \"en_favorite_subject\": \"<string>\",\n \"en_test_check_box\": \"<string>\",\n \"en_test_field_boolea\": \"<string>\",\n \"en_test_checkbox_2\": \"<string>\",\n \"client_id\": \"<string>\",\n \"program_id\": 123,\n \"status\": \"<string>\",\n \"re_add\": \"<string>\",\n \"sp_amount\": \"<string>\",\n \"sp_num\": \"<string>\",\n \"wait_time\": \"<string>\",\n \"json_fields\": \"<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/program/entity")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_id\": 123,\n \"en_child_name\": \"<string>\",\n \"en_gender\": \"<string>\",\n \"en_grade\": \"<string>\",\n \"en_age\": \"<string>\",\n \"en_birthdate\": \"<string>\",\n \"en_favorite_subject\": \"<string>\",\n \"en_test_check_box\": \"<string>\",\n \"en_test_field_boolea\": \"<string>\",\n \"en_test_checkbox_2\": \"<string>\",\n \"client_id\": \"<string>\",\n \"program_id\": 123,\n \"status\": \"<string>\",\n \"re_add\": \"<string>\",\n \"sp_amount\": \"<string>\",\n \"sp_num\": \"<string>\",\n \"wait_time\": \"<string>\",\n \"json_fields\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/program/entity")
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 \"entity_id\": 123,\n \"en_child_name\": \"<string>\",\n \"en_gender\": \"<string>\",\n \"en_grade\": \"<string>\",\n \"en_age\": \"<string>\",\n \"en_birthdate\": \"<string>\",\n \"en_favorite_subject\": \"<string>\",\n \"en_test_check_box\": \"<string>\",\n \"en_test_field_boolea\": \"<string>\",\n \"en_test_checkbox_2\": \"<string>\",\n \"client_id\": \"<string>\",\n \"program_id\": 123,\n \"status\": \"<string>\",\n \"re_add\": \"<string>\",\n \"sp_amount\": \"<string>\",\n \"sp_num\": \"<string>\",\n \"wait_time\": \"<string>\",\n \"json_fields\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Profile saved"
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Data required for editing the entity
Response
200 - application/json
Entity edited successfully
Example:
"Profile saved"
Previous
Post Edit Multiple EntitiesHandles the submission of edited data for multiple entities,
* including updating various fields and maintaining archival status if applicable.
Next
⌘I
Post Edit Entity
curl --request PUT \
--url https://api.helpyousponsor.com/v1/admin/program/entity \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"entity_id": 123,
"en_child_name": "<string>",
"en_gender": "<string>",
"en_grade": "<string>",
"en_age": "<string>",
"en_birthdate": "<string>",
"en_favorite_subject": "<string>",
"en_test_check_box": "<string>",
"en_test_field_boolea": "<string>",
"en_test_checkbox_2": "<string>",
"client_id": "<string>",
"program_id": 123,
"status": "<string>",
"re_add": "<string>",
"sp_amount": "<string>",
"sp_num": "<string>",
"wait_time": "<string>",
"json_fields": "<string>"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/program/entity"
payload = {
"entity_id": 123,
"en_child_name": "<string>",
"en_gender": "<string>",
"en_grade": "<string>",
"en_age": "<string>",
"en_birthdate": "<string>",
"en_favorite_subject": "<string>",
"en_test_check_box": "<string>",
"en_test_field_boolea": "<string>",
"en_test_checkbox_2": "<string>",
"client_id": "<string>",
"program_id": 123,
"status": "<string>",
"re_add": "<string>",
"sp_amount": "<string>",
"sp_num": "<string>",
"wait_time": "<string>",
"json_fields": "<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({
entity_id: 123,
en_child_name: '<string>',
en_gender: '<string>',
en_grade: '<string>',
en_age: '<string>',
en_birthdate: '<string>',
en_favorite_subject: '<string>',
en_test_check_box: '<string>',
en_test_field_boolea: '<string>',
en_test_checkbox_2: '<string>',
client_id: '<string>',
program_id: 123,
status: '<string>',
re_add: '<string>',
sp_amount: '<string>',
sp_num: '<string>',
wait_time: '<string>',
json_fields: '<string>'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/program/entity', 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/program/entity",
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([
'entity_id' => 123,
'en_child_name' => '<string>',
'en_gender' => '<string>',
'en_grade' => '<string>',
'en_age' => '<string>',
'en_birthdate' => '<string>',
'en_favorite_subject' => '<string>',
'en_test_check_box' => '<string>',
'en_test_field_boolea' => '<string>',
'en_test_checkbox_2' => '<string>',
'client_id' => '<string>',
'program_id' => 123,
'status' => '<string>',
're_add' => '<string>',
'sp_amount' => '<string>',
'sp_num' => '<string>',
'wait_time' => '<string>',
'json_fields' => '<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/program/entity"
payload := strings.NewReader("{\n \"entity_id\": 123,\n \"en_child_name\": \"<string>\",\n \"en_gender\": \"<string>\",\n \"en_grade\": \"<string>\",\n \"en_age\": \"<string>\",\n \"en_birthdate\": \"<string>\",\n \"en_favorite_subject\": \"<string>\",\n \"en_test_check_box\": \"<string>\",\n \"en_test_field_boolea\": \"<string>\",\n \"en_test_checkbox_2\": \"<string>\",\n \"client_id\": \"<string>\",\n \"program_id\": 123,\n \"status\": \"<string>\",\n \"re_add\": \"<string>\",\n \"sp_amount\": \"<string>\",\n \"sp_num\": \"<string>\",\n \"wait_time\": \"<string>\",\n \"json_fields\": \"<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/program/entity")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_id\": 123,\n \"en_child_name\": \"<string>\",\n \"en_gender\": \"<string>\",\n \"en_grade\": \"<string>\",\n \"en_age\": \"<string>\",\n \"en_birthdate\": \"<string>\",\n \"en_favorite_subject\": \"<string>\",\n \"en_test_check_box\": \"<string>\",\n \"en_test_field_boolea\": \"<string>\",\n \"en_test_checkbox_2\": \"<string>\",\n \"client_id\": \"<string>\",\n \"program_id\": 123,\n \"status\": \"<string>\",\n \"re_add\": \"<string>\",\n \"sp_amount\": \"<string>\",\n \"sp_num\": \"<string>\",\n \"wait_time\": \"<string>\",\n \"json_fields\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/program/entity")
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 \"entity_id\": 123,\n \"en_child_name\": \"<string>\",\n \"en_gender\": \"<string>\",\n \"en_grade\": \"<string>\",\n \"en_age\": \"<string>\",\n \"en_birthdate\": \"<string>\",\n \"en_favorite_subject\": \"<string>\",\n \"en_test_check_box\": \"<string>\",\n \"en_test_field_boolea\": \"<string>\",\n \"en_test_checkbox_2\": \"<string>\",\n \"client_id\": \"<string>\",\n \"program_id\": 123,\n \"status\": \"<string>\",\n \"re_add\": \"<string>\",\n \"sp_amount\": \"<string>\",\n \"sp_num\": \"<string>\",\n \"wait_time\": \"<string>\",\n \"json_fields\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Profile saved"
}
