Skip to content

Create a form

Request

Create a new form which can be used to collect additional information from customers upon ticket purchase.

Security
SessionKey(Required scopes: customeradministrator)
Path
hostintegerrequired

Unique identifier of the requested host

Bodyapplication/json
namestringrequired

Human-readable name that uniquely identifies the form

descriptionstringrequired

Text describing the type of additional information the form is designed to collect.

fieldsArray of objects, non-emptyrequired
curl -i -X POST \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}/forms' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Meal Options",
    "description": "Collect meal options from our mas players to prepare appropriate amounts for breakfast.",
    "fields": [
      {
        "name": "Soup",
        "type": "short_text"
      },
      {
        "name": "Main",
        "type": "short_text"
      },
      {
        "name": "Drink",
        "type": "short_text"
      }
    ]
  }'

Responses

The new form was successfully created.

Bodyapplication/json
selfstring

URI of the form resource

namestring

Human-readable name that uniquely identifies the form

descriptionstring

Text describing the type of additional information the form is designed to collect.

fieldsArray of objects
Response
{
  "self": "/hosts/14271847571941/forms/1927471842571142",
  "name": "Meal Options",
  "description": "Collect meal options from our mas players to prepare appropriate amounts for breakfast.",
  "fields": [
    { … },
    { … },
    { … }
  ]
}