Skip to main content
POST
/
admin
/
fields
/
options
/
{program_id}
/
{type}
Post Field Options
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/fields/options/{program_id}/{type} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data @- <<EOF
{
  "client_id": "<string>",
  "program": [
    "['client_id', 'program_id', 'en_child_name', 'en_gender', 'report_name']"
  ],
  "en_child_name": true,
  "en_child_gender": true,
  "report_name": "<string>",
  "program_id": 123
}
EOF
{
  "message": "Preferences Saved"
}

Authorizations

​
X-HYS-API-Key
string
header
required

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

Path Parameters

​
program_id
string
required

Program ID for which to save field options

​
type
string
required

Type of the field options to save

Body

application/json

Data for field options to save

​
client_id
string
​
program
string[]
​
en_child_name
boolean
Example:

true

​
en_child_gender
boolean
Example:

true

​
report_name
string
​
program_id
integer

Response

200 - application/json

Field options saved successfully

​
message
string
Example:

"Preferences Saved"