Delete a file - HelpYouSponsor Docs

DELETE

frontend

donor

dashboard

file

{client_id}

{program_id}

{id}

{entity_id}

{session_id}

Delete a file

curl --request DELETE \
  --url https://api.helpyousponsor.com/v1/frontend/donor/dashboard/file/{client_id}/{program_id}/{id}/{entity_id}/{session_id} \
  --header 'session_id: <api-key>'

{
  "status": "success",
  "redirect": "/frontend/donor_upload/{client_id}/{program_id}/{entity_id}/{session_id}"
}

Authorizations

session_id

string

header

required

Use a session id to authenticate

Path Parameters

client_id

integer

required

The ID of the client

program_id

integer

required

The ID of the program

integer

required

The ID of the file to delete

entity_id

integer

required

The ID of the entity

session_id

string

required

The ID of the session

Response

Success

status

string

Example:

"success"

redirect

string

Example:

"/frontend/donor_upload/{client_id}/{program_id}/{entity_id}/{session_id}"

Donor Credit Card InformationAllows a donor to update their credit card information.

Delete a file

curl --request DELETE \
  --url https://api.helpyousponsor.com/v1/frontend/donor/dashboard/file/{client_id}/{program_id}/{id}/{entity_id}/{session_id} \
  --header 'session_id: <api-key>'

{
  "status": "success",
  "redirect": "/frontend/donor_upload/{client_id}/{program_id}/{entity_id}/{session_id}"
}