Permanently delete an entity - HelpYouSponsor Docs

DELETE

admin

entity

{entity_id}

delete

Permanently delete an entity

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

{
  "message": "<string>"
}

X-HYS-API-Key

string

header

required

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

entity_id

integer

required

ID of the entity to be deleted

Entity successfully deleted

message

string

Permanently delete an entity

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

{
  "message": "<string>"
}