Entities
Post Edit Multiple Entities
Handles the submission of edited data for multiple entities,
- including updating various fields and maintaining archival status if applicable.
PATCH
/
admin
/
program
/
entities
Post Edit Multiple Entities
curl --request PATCH \
--url https://api.helpyousponsor.com/v1/admin/program/entities \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"entity_ids": [
"1,2"
],
"values": {
"sp_amount": "40"
}
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/program/entities"
payload = {
"entity_ids": ["1,2"],
"values": { "sp_amount": "40" }
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entity_ids: ['1,2'], values: {sp_amount: '40'}})
};
fetch('https://api.helpyousponsor.com/v1/admin/program/entities', 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/entities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'entity_ids' => [
'1,2'
],
'values' => [
'sp_amount' => '40'
]
]),
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/entities"
payload := strings.NewReader("{\n \"entity_ids\": [\n \"1,2\"\n ],\n \"values\": {\n \"sp_amount\": \"40\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.helpyousponsor.com/v1/admin/program/entities")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_ids\": [\n \"1,2\"\n ],\n \"values\": {\n \"sp_amount\": \"40\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/program/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_ids\": [\n \"1,2\"\n ],\n \"values\": {\n \"sp_amount\": \"40\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Profile saved"
}{
"message": "No values to update"
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Data required for editing multiple entities
Response
Entities edited successfully
Example:
"Profile saved"
⌘I
Post Edit Multiple Entities
curl --request PATCH \
--url https://api.helpyousponsor.com/v1/admin/program/entities \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"entity_ids": [
"1,2"
],
"values": {
"sp_amount": "40"
}
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/program/entities"
payload = {
"entity_ids": ["1,2"],
"values": { "sp_amount": "40" }
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entity_ids: ['1,2'], values: {sp_amount: '40'}})
};
fetch('https://api.helpyousponsor.com/v1/admin/program/entities', 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/entities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'entity_ids' => [
'1,2'
],
'values' => [
'sp_amount' => '40'
]
]),
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/entities"
payload := strings.NewReader("{\n \"entity_ids\": [\n \"1,2\"\n ],\n \"values\": {\n \"sp_amount\": \"40\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.helpyousponsor.com/v1/admin/program/entities")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_ids\": [\n \"1,2\"\n ],\n \"values\": {\n \"sp_amount\": \"40\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/program/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_ids\": [\n \"1,2\"\n ],\n \"values\": {\n \"sp_amount\": \"40\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Profile saved"
}{
"message": "No values to update"
}
