For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom Field

List all custom fields in an event question library

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstringRequired
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/custom-field/all
GET /public-api/v1/event/{eventId}/custom-field/all HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "dataList": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "TEXT",
      "contentI18n": {
        "label": {
          "default": "Company Name"
        }
      },
      "isFilterable": true,
      "archivedAt": null,
      "rawData": {
        "type": "TEXT",
        "contentI18n": {
          "label": {
            "default": "Company Name"
          }
        },
        "isFilterable": true
      }
    }
  ]
}

Bulk create or update custom fields

put

Idempotent upsert. Items with an id are updated; items without an id are created. Custom fields are always optional (isRequired: false).

Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Body

Request body for bulk creating or updating custom fields. Include an id to update; omit to create.

Responses
200

Success

application/json
put/public-api/v1/event/{eventId}/custom-field/bulk-upsert
PUT /public-api/v1/event/{eventId}/custom-field/bulk-upsert HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 394

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "TEXT",
      "contentI18n": {
        "label": {
          "default": "Company Name"
        }
      },
      "isFilterable": false
    },
    {
      "type": "DROPDOWN",
      "contentI18n": {
        "label": {
          "default": "Dietary Preference"
        }
      },
      "isFilterable": true,
      "config": {
        "options": [
          {
            "id": "opt-1",
            "contentI18n": {
              "label": {
                "default": "Vegetarian"
              }
            }
          },
          {
            "id": "opt-2",
            "contentI18n": {
              "label": {
                "default": "Non-Vegetarian"
              }
            }
          }
        ]
      }
    }
  ]
}
{
  "dataList": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "TEXT",
      "contentI18n": {
        "label": {
          "default": "Company Name"
        }
      },
      "isFilterable": true,
      "archivedAt": null,
      "rawData": {
        "type": "TEXT",
        "contentI18n": {
          "label": {
            "default": "Company Name"
          }
        },
        "isFilterable": true
      }
    }
  ]
}

Last updated