Upload a file - HelpYouSponsor Docs

POST

/

file

/

{type}

/

{id}

/

upload

Upload a file

curl --request POST \
  --url https://api.helpyousponsor.com/v1/file/{type}/{id}/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-HYS-API-Key: <api-key>' \
  --form file='@example-file'

{
  "message": "Successful"
}

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

Body

multipart/form-data

File to be uploaded

file

File to be uploaded

Response

Successful operation

message

string

Example:

"Successful"

curl --request POST \
  --url https://api.helpyousponsor.com/v1/file/{type}/{id}/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-HYS-API-Key: <api-key>' \
  --form file='@example-file'

{
  "message": "Successful"
}