Create a new form - HelpYouSponsor Docs

POST

/

admin

/

forms

Create a new form

curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/forms \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "name": "Donation Form",
  "type": "entity",
  "client_id": 1
}
'

{
  "message": "Successfully Created Form"
}

Authorizations

X-HYS-API-Key

string

header

required

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

Body

application/json

name

string

The name of the form

Example:

"Donation Form"

type

string

The type of the form

Example:

"entity"

client_id

string

The id of the client

Example:

1

Response

Successfully created form

message

string

Example:

"Successfully Created Form"

curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/forms \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "name": "Donation Form",
  "type": "entity",
  "client_id": 1
}
'

{
  "message": "Successfully Created Form"
}