Archive Entity - HelpYouSponsor Docs

DELETE

admin

entity

{entity_id}

Archive Entity

curl --request DELETE \
  --url https://api.helpyousponsor.com/v1/admin/entity/{entity_id} \
  --header 'X-HYS-API-Key: <api-key>'

{
  "message": "Successfully Archived."
}

X-HYS-API-Key

string

header

required

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

entity_id

integer

required

Entity ID of the entity to archive

Entity successfully archived

message

string

Example:

"Successfully Archived."

Archive Entity

curl --request DELETE \
  --url https://api.helpyousponsor.com/v1/admin/entity/{entity_id} \
  --header 'X-HYS-API-Key: <api-key>'

{
  "message": "Successfully Archived."
}