Permanently delete entities - HelpYouSponsor Docs

DELETE

admin

entities

{program_id}

delete

Permanently delete entities

curl --request DELETE \
  --url https://api.helpyousponsor.com/v1/admin/entities/{program_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_...

program_id

integer

required

The id of the program

entity_ids

string

required

Comma-separated list of entity IDs to delete

Example:

"1,2,3"

Entities successfully deleted

message

string

Permanently delete entities

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

{
  "message": "<string>"
}