> For the complete documentation index, see [llms.txt](https://eventx-hq.gitbook.io/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eventx-hq.gitbook.io/knowledge-base/api-doc/custom-field.md).

# Custom Field

## GET /public-api/v1/event/{eventId}/custom-field/all

> List all custom fields in an event question library

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/custom-field/all":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["text","multipleText","textArea","singleCheckbox","radioGroup","checkboxGroup","dropdown","fileUpload","datePicker","phoneField","timePicker"]},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false},"isFilterable":{"type":"boolean","default":false},"config":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false}},"required":["id","contentI18n"],"additionalProperties":false},"uniqueItems":true}},"required":["options"],"additionalProperties":false},{"type":"object","properties":{"minDate":{"type":"string","format":"date"},"maxDate":{"type":"string","format":"date","oneOf":[{"type":"string","format":"date"}]}},"additionalProperties":false},{"type":"object","properties":{"hideMeridiem":{"type":"boolean"}},"additionalProperties":false}]},"archivedAt":{"type":"string","format":"date-time","nullable":true},"rawData":{"type":"object","properties":{"type":{"type":"string","enum":["text","multipleText","textArea","singleCheckbox","radioGroup","checkboxGroup","dropdown","fileUpload","datePicker","phoneField","timePicker"]},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false},"isFilterable":{"type":"boolean","default":false},"config":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false}},"required":["id","contentI18n"],"additionalProperties":false},"uniqueItems":true}},"required":["options"],"additionalProperties":false},{"type":"object","properties":{"minDate":{"type":"string","format":"date"},"maxDate":{"type":"string","format":"date","oneOf":[{"type":"string","format":"date"}]}},"additionalProperties":false},{"type":"object","properties":{"hideMeridiem":{"type":"boolean"}},"additionalProperties":false}]}},"required":["type","contentI18n"],"additionalProperties":false}},"required":["id","type","contentI18n","isFilterable","config","archivedAt","rawData"],"additionalProperties":false,"description":"Custom field (question) from an event question library"}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Custom Field"],"operationId":"getAllCustomFieldByEventId","summary":"List all custom fields in an event question library"}}}}
```

## Bulk create or update custom fields

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

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/custom-field/bulk-upsert":{"put":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["text","multipleText","textArea","singleCheckbox","radioGroup","checkboxGroup","dropdown","fileUpload","datePicker","phoneField","timePicker"]},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false},"isFilterable":{"type":"boolean","default":false},"config":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false}},"required":["id","contentI18n"],"additionalProperties":false},"uniqueItems":true}},"required":["options"],"additionalProperties":false},{"type":"object","properties":{"minDate":{"type":"string","format":"date"},"maxDate":{"type":"string","format":"date","oneOf":[{"type":"string","format":"date"}]}},"additionalProperties":false},{"type":"object","properties":{"hideMeridiem":{"type":"boolean"}},"additionalProperties":false}]},"archivedAt":{"type":"string","format":"date-time","nullable":true},"rawData":{"type":"object","properties":{"type":{"type":"string","enum":["text","multipleText","textArea","singleCheckbox","radioGroup","checkboxGroup","dropdown","fileUpload","datePicker","phoneField","timePicker"]},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false},"isFilterable":{"type":"boolean","default":false},"config":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false}},"required":["id","contentI18n"],"additionalProperties":false},"uniqueItems":true}},"required":["options"],"additionalProperties":false},{"type":"object","properties":{"minDate":{"type":"string","format":"date"},"maxDate":{"type":"string","format":"date","oneOf":[{"type":"string","format":"date"}]}},"additionalProperties":false},{"type":"object","properties":{"hideMeridiem":{"type":"boolean"}},"additionalProperties":false}]}},"required":["type","contentI18n"],"additionalProperties":false}},"required":["id","type","contentI18n","isFilterable","config","archivedAt","rawData"],"additionalProperties":false,"description":"Custom field (question) from an event question library"}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"When provide resource Id, it will update the resource, otherwise it will create a new resource"},"type":{"type":"string","enum":["text","multipleText","textArea","singleCheckbox","radioGroup","checkboxGroup","dropdown","fileUpload","datePicker","phoneField","timePicker"]},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false},"isFilterable":{"type":"boolean","default":false},"config":{"type":"object","properties":{},"additionalProperties":false,"oneOf":[{"type":"object","properties":{"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentI18n":{"type":"object","properties":{"label":{"type":"object","properties":{"default":{"type":"string","nullable":true},"en":{"type":"string","nullable":true},"ja":{"type":"string","nullable":true},"ko":{"type":"string","nullable":true},"vi":{"type":"string","nullable":true},"zh-HK":{"type":"string","nullable":true},"zh-CN":{"type":"string","nullable":true},"es":{"type":"string","nullable":true},"th":{"type":"string","nullable":true},"pt":{"type":"string","nullable":true}},"required":["default"],"additionalProperties":false}},"required":["label"],"additionalProperties":false}},"required":["id","contentI18n"],"additionalProperties":false},"uniqueItems":true}},"required":["options"],"additionalProperties":false},{"type":"object","properties":{"minDate":{"type":"string","format":"date"},"maxDate":{"type":"string","format":"date","oneOf":[{"type":"string","format":"date"}]}},"additionalProperties":false},{"type":"object","properties":{"hideMeridiem":{"type":"boolean"}},"additionalProperties":false}]}},"required":["type","contentI18n"],"additionalProperties":false},"uniqueItems":true}},"additionalProperties":false,"description":"Request body for bulk creating or updating custom fields. Include an `id` to update; omit to create."}}}},"tags":["Custom Field"],"operationId":"bulkUpsertCustomFieldByEventId","summary":"Bulk create or update custom fields","description":"Idempotent upsert. Items with an id are updated; items without an id are created. Custom fields are always optional (isRequired: false)."}}}}
```