# Custom Field

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

> List all custom fields in an event question library

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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","format":"uuid"},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"],"format":"date-time"},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string"},"name":"eventId","in":"path"}],"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.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"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","format":"uuid"},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"],"format":"date-time"},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"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).","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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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","null"]},"en":{"type":["string","null"]},"ja":{"type":["string","null"]},"ko":{"type":["string","null"]},"vi":{"type":["string","null"]},"zh-HK":{"type":["string","null"]},"zh-CN":{"type":["string","null"]},"es":{"type":["string","null"]},"th":{"type":["string","null"]},"pt":{"type":["string","null"]}},"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}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://eventx-hq.gitbook.io/knowledge-base/api-doc/custom-field.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.