Skip to main content
GET
/
file
/
{type}
/
{id}
/
upload
Upload a file
curl --request GET \
  --url https://api.helpyousponsor.com/v1/file/{type}/{id}/upload \
  --header 'X-HYS-API-Key: <api-key>'
{
  "type": "entity",
  "id": 1,
  "name": "John Doe",
  "program": {},
  "hysform": {},
  "entity": {},
  "program_id": "program1",
  "profileThumb": "http://example.com/thumb.jpg",
  "submit": [
    {}
  ],
  "donor": {},
  "slug": "5f4dcc3b5aa765d61d8327deb882cf99",
  "upload": {},
  "box_access_token": "access_token",
  "box_folder_id": "folder_id",
  "emailsets": false,
  "years": [
    {}
  ],
  "template_errors": [
    {}
  ]
}

Authorizations

​
X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

Path Parameters

​
type
string
required

Type of the file (entity or donor)

​
id
integer
required

ID of the entity or donor

Response

Successful operation

​
type
string
Example:

"entity"

​
id
integer
Example:

1

​
name
string
Example:

"John Doe"

​
program
object
​
hysform
object
​
entity
object
​
program_id
string
Example:

"program1"

​
profileThumb
string
Example:

"http://example.com/thumb.jpg"

​
submit
object[]
​
donor
object
​
slug
string
Example:

"5f4dcc3b5aa765d61d8327deb882cf99"

​
upload
object
​
box_access_token
string
Example:

"access_token"

​
box_folder_id
string
Example:

"folder_id"

​
emailsets
boolean
Example:

false

​
years
object[]
​
template_errors
object[]