Add New Entity - HelpYouSponsor Docs

POST

/

admin

/

entity

/

{program_id}

Add New Entity

curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/entity/{program_id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "en_child_name": "<string>",
  "en_gender": "<string>",
  "en_test_checkbox_2": "<string>",
  "program_id": 123,
  "sp_num": "<string>",
  "sp_amount": "<string>"
}
'

{
  "message": "Entity Profile saved"
}

Authorizations

X-HYS-API-Key

string

header

required

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

Path Parameters

program_id

integer

required

Program ID

Body

application/json

Data required for adding a new entity

en_child_name

string

en_gender

string

en_test_checkbox_2

string

program_id

integer

sp_num

string

sp_amount

string

Response

Entity added successfully

message

string

Example:

"Entity Profile saved"

curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/entity/{program_id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "en_child_name": "<string>",
  "en_gender": "<string>",
  "en_test_checkbox_2": "<string>",
  "program_id": 123,
  "sp_num": "<string>",
  "sp_amount": "<string>"
}
'

{
  "message": "Entity Profile saved"
}