Archive Entities - HelpYouSponsor Docs

DELETE

admin

entities

{program_id}

Archive Entities

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

{
  "message": "Successfully Removed"
}

X-HYS-API-Key

string

header

required

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

program_id

integer

required

Program ID from which to remove entities

entity_ids

string

required

Comma-separated list of entity IDs to delete

Example:

"1,2,3"

200 - application/json

Entities successfully removed

message

string

Example:

"Successfully Removed"

Archive Entities

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

{
  "message": "Successfully Removed"
}

Documentation Index