---
title: "Add custom fields"
method: POST
path: "/omni/add/custom-fields"
tags: ["Custom fields"]
---

# Add custom fields

`POST /omni/add/custom-fields`

This endpoint is used for adding custom fields to current onboarding session.
The key must match one of the keys that are defined for the Organization, and the value must be of the type
that is defined for the corresponding key.

## Headers

- `api-version` string, required

## Request body

- CustomFieldsRequest
  - `customFields` object — Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength}

## Response `200`

OK

- BasicResponse
  - `success` boolean — Flag indicating request passed successfully.
  - `sessionStatus` 'Alive' | 'Closed' | 'Deleted' — Session status

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/incode/apis/incode-omni-api.md) · [All operations](https://skmtc.net/incode/apis/incode-omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/incode/incode-omni-api/revisions/30cd6d926ea3/schema)