Registration Form

Create a registration form for an event

post

Authorizations

AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters

eventIdstring · uuidRequired

Body

Request body for creating a registration form

namestringRequired

isEnabledbooleanRequired

ticketClassIdsstring · uuid[]Required

isUniqueAttendeeEmailRequiredbooleanOptionalDefault: false

isCheckInQRCodeVisibleOnCompletionbooleanOptionalDefault: false

isPromoCodeFieldEnabledbooleanOptionalDefault: true

isPurchaserEmailFieldEnabledbooleanOptionalDefault: true

isAddOnGroupDisplayEnabledbooleanOptionalDefault: false

minTicketQtyPerOrdernumber · floatOptionalDefault: 1

maxTicketQtyPerOrdernumber · floatOptionalDefault: 10

Responses

200

Success

application/json

500

ERROR

post/public-api/v1/event/{eventId}/registration-form

POST /public-api/v1/event/{eventId}/registration-form HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 444

{
  "name": "Standard Registration",
  "isEnabled": true,
  "fields": [
    {
      "id": "fullName",
      "isRequired": true
    },
    {
      "id": "email",
      "isRequired": true
    }
  ],
  "conditionalLogics": [],
  "ticketClassIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "isUniqueAttendeeEmailRequired": false,
  "isCheckInQRCodeVisibleOnCompletion": false,
  "isPromoCodeFieldEnabled": true,
  "isPurchaserEmailFieldEnabled": true,
  "isAddOnGroupDisplayEnabled": false,
  "minTicketQtyPerOrder": 1,
  "maxTicketQtyPerOrder": 10
}

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Standard Registration",
    "isEnabled": true,
    "fields": [
      {
        "id": "fullName",
        "type": "TEXT",
        "isRequired": true
      },
      {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "type": "TEXT",
        "label": "Company Name",
        "isRequired": false,
        "contentI18n": {
          "label": {
            "default": "Company Name"
          }
        }
      }
    ],
    "conditionalLogics": [],
    "tickets": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440002",
        "ticketAvailableCount": 500,
        "currency": "HKD",
        "qty": 500,
        "price": "100.00",
        "saleStartsAt": "2024-01-01T00:00:00.000Z",
        "saleEndsAt": null,
        "minAddOnQty": 0,
        "maxAddOnQty": null,
        "name": "General Admission",
        "addOns": [],
        "addOnGroups": []
      }
    ],
    "isAddOnGroupDisplayEnabled": false
  }
}