Files
Post a record upload
POST
/
admin
/
recordUpload
Post a record upload
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/recordUpload \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"client_id": "5",
"status": 5,
"hys_slug": "file_slug",
"hys_ext": "jpg",
"file_id": "821da627-08eb-458d-a119",
"box_url": "",
"name": "file_name",
"hys_type": "donor",
"hys_id": "1",
"type": "image/jpeg"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/recordUpload"
payload = {
"client_id": "5",
"status": 5,
"hys_slug": "file_slug",
"hys_ext": "jpg",
"file_id": "821da627-08eb-458d-a119",
"box_url": "",
"name": "file_name",
"hys_type": "donor",
"hys_id": "1",
"type": "image/jpeg"
}
headers = {
"X-HYS-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-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '5',
status: 5,
hys_slug: 'file_slug',
hys_ext: 'jpg',
file_id: '821da627-08eb-458d-a119',
box_url: '',
name: 'file_name',
hys_type: 'donor',
hys_id: '1',
type: 'image/jpeg'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/recordUpload', 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/recordUpload",
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([
'client_id' => '5',
'status' => 5,
'hys_slug' => 'file_slug',
'hys_ext' => 'jpg',
'file_id' => '821da627-08eb-458d-a119',
'box_url' => '',
'name' => 'file_name',
'hys_type' => 'donor',
'hys_id' => '1',
'type' => 'image/jpeg'
]),
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/recordUpload"
payload := strings.NewReader("{\n \"client_id\": \"5\",\n \"status\": 5,\n \"hys_slug\": \"file_slug\",\n \"hys_ext\": \"jpg\",\n \"file_id\": \"821da627-08eb-458d-a119\",\n \"box_url\": \"\",\n \"name\": \"file_name\",\n \"hys_type\": \"donor\",\n \"hys_id\": \"1\",\n \"type\": \"image/jpeg\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.helpyousponsor.com/v1/admin/recordUpload")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"5\",\n \"status\": 5,\n \"hys_slug\": \"file_slug\",\n \"hys_ext\": \"jpg\",\n \"file_id\": \"821da627-08eb-458d-a119\",\n \"box_url\": \"\",\n \"name\": \"file_name\",\n \"hys_type\": \"donor\",\n \"hys_id\": \"1\",\n \"type\": \"image/jpeg\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/recordUpload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"5\",\n \"status\": 5,\n \"hys_slug\": \"file_slug\",\n \"hys_ext\": \"jpg\",\n \"file_id\": \"821da627-08eb-458d-a119\",\n \"box_url\": \"\",\n \"name\": \"file_name\",\n \"hys_type\": \"donor\",\n \"hys_id\": \"1\",\n \"type\": \"image/jpeg\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Successfully posted to Box"
}{
"message": "Invalid data"
}Authorizations
API key generated from Developer Settings. Format: hys_...
Body
application/json
Data for the record upload
Response
Successfully posted to Box
Example:
"Successfully posted to Box"
⌘I
Post a record upload
curl --request POST \
--url https://api.helpyousponsor.com/v1/admin/recordUpload \
--header 'Content-Type: application/json' \
--header 'X-HYS-API-Key: <api-key>' \
--data '
{
"client_id": "5",
"status": 5,
"hys_slug": "file_slug",
"hys_ext": "jpg",
"file_id": "821da627-08eb-458d-a119",
"box_url": "",
"name": "file_name",
"hys_type": "donor",
"hys_id": "1",
"type": "image/jpeg"
}
'import requests
url = "https://api.helpyousponsor.com/v1/admin/recordUpload"
payload = {
"client_id": "5",
"status": 5,
"hys_slug": "file_slug",
"hys_ext": "jpg",
"file_id": "821da627-08eb-458d-a119",
"box_url": "",
"name": "file_name",
"hys_type": "donor",
"hys_id": "1",
"type": "image/jpeg"
}
headers = {
"X-HYS-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-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
client_id: '5',
status: 5,
hys_slug: 'file_slug',
hys_ext: 'jpg',
file_id: '821da627-08eb-458d-a119',
box_url: '',
name: 'file_name',
hys_type: 'donor',
hys_id: '1',
type: 'image/jpeg'
})
};
fetch('https://api.helpyousponsor.com/v1/admin/recordUpload', 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/recordUpload",
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([
'client_id' => '5',
'status' => 5,
'hys_slug' => 'file_slug',
'hys_ext' => 'jpg',
'file_id' => '821da627-08eb-458d-a119',
'box_url' => '',
'name' => 'file_name',
'hys_type' => 'donor',
'hys_id' => '1',
'type' => 'image/jpeg'
]),
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/recordUpload"
payload := strings.NewReader("{\n \"client_id\": \"5\",\n \"status\": 5,\n \"hys_slug\": \"file_slug\",\n \"hys_ext\": \"jpg\",\n \"file_id\": \"821da627-08eb-458d-a119\",\n \"box_url\": \"\",\n \"name\": \"file_name\",\n \"hys_type\": \"donor\",\n \"hys_id\": \"1\",\n \"type\": \"image/jpeg\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.helpyousponsor.com/v1/admin/recordUpload")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_id\": \"5\",\n \"status\": 5,\n \"hys_slug\": \"file_slug\",\n \"hys_ext\": \"jpg\",\n \"file_id\": \"821da627-08eb-458d-a119\",\n \"box_url\": \"\",\n \"name\": \"file_name\",\n \"hys_type\": \"donor\",\n \"hys_id\": \"1\",\n \"type\": \"image/jpeg\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helpyousponsor.com/v1/admin/recordUpload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_id\": \"5\",\n \"status\": 5,\n \"hys_slug\": \"file_slug\",\n \"hys_ext\": \"jpg\",\n \"file_id\": \"821da627-08eb-458d-a119\",\n \"box_url\": \"\",\n \"name\": \"file_name\",\n \"hys_type\": \"donor\",\n \"hys_id\": \"1\",\n \"type\": \"image/jpeg\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Successfully posted to Box"
}{
"message": "Invalid data"
}
