Edit a file - HelpYouSponsor Docs

PUT

/

file

/

{id}

Edit a file

curl --request PUT \
  --url https://api.helpyousponsor.com/v1/file/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "id": 1,
  "file_name": "<string>",
  "type": "image",
  "permissions": "donor"
}
'

{
  "message": "Successfully Edited File"
}

Authorizations

X-HYS-API-Key

string

header

required

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

Path Parameters

id

integer

required

ID of the file to be edited

Body

application/json

File data that needs to be updated

id

integer

Example:

1

file_name

string

The name of the file

type

string

Example:

"image"

permissions

string

Example:

"donor"

Response

Successfully Edited File

message

string

Example:

"Successfully Edited File"

curl --request PUT \
  --url https://api.helpyousponsor.com/v1/file/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "id": 1,
  "file_name": "<string>",
  "type": "image",
  "permissions": "donor"
}
'

{
  "message": "Successfully Edited File"
}