> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/platform/custom-fields/checkbox-field.md).

# Checkbox Field

Collect simple Yes/No answers from customers in the Basket. Learn how to create a checkbox field and how it appears on the Basket form.

A checkbox custom field is useful for collecting simple Yes/No responses from your customers. For example, you can use it to confirm agreement with terms and conditions, sign up for a newsletter, or request gift packaging.

{% hint style="info" %}
The checkbox is available only for the **Basket** scope. Your account type and plan may limit the number of custom fields you can create.
{% endhint %}

***

## Create a checkbox field

{% stepper %}
{% step %}

### Open Custom Fields

Go to **Settings**, find **Custom Fields** under the **Data** section, and click **New Custom Field**.
{% endstep %}

{% step %}

### Set the scope and type

Set **Field Scope** to **Basket** and select **Type**: **Checkbox**.
{% endstep %}

{% step %}

### Fill in the field details

Provide the remaining required information.

<table><thead><tr><th width="60">#</th><th>Setting</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td><strong>Name</strong></td><td>The name for the checkbox custom field, visible in the admin panel and, after Basket submission, in the preview, email and PDF. Required.</td></tr><tr><td>2</td><td><strong>ID</strong></td><td>Automatically generated ID from the name in a URL-friendly format. Required.</td></tr><tr><td>3</td><td><strong>Field Scope</strong></td><td>Checkbox is available only for use in the Basket. Required.</td></tr><tr><td>4</td><td><strong>Type</strong></td><td>Checkbox. Required.</td></tr><tr><td>5</td><td><strong>Checked State Label</strong></td><td>Label visible after Basket submission in the app, email and PDF (e.g. Checked, Agreed). Required.</td></tr><tr><td>6</td><td><strong>Unchecked State Label</strong></td><td>Label visible after Basket submission in the app, email and PDF (e.g. Unchecked, Denied). Required.</td></tr><tr><td>7</td><td><strong>Checkbox Content</strong></td><td>Label displayed next to the checkbox, e.g. "I agree to Terms &#x26; Conditions". Required.</td></tr><tr><td>8</td><td><strong>Required Setting</strong></td><td>Defines whether the checkbox is required or not.</td></tr><tr><td>9</td><td><strong>Position Setting</strong></td><td>Defines whether the checkbox is positioned within the Basket form or fixed in the footer.</td></tr></tbody></table>

![New Custom Field form with checkbox settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FwUGkSQpQSb0H5Uy58ZXA%2Fcustom-fields-checkbox-11_c72l5.png?alt=media)
{% endstep %}
{% endstepper %}

***

## How it appears in the Basket

Once you've created a checkbox custom field and added it to the Basket form, it is visible to customers submitting their Baskets. Below are examples of how the checkbox appears when fixed in the footer, within the form, and in an error state.

![Checkbox field fixed in the footer, within the Basket form, and in an error state](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Ff6OAnOFHzNPNWy1bx3co%2Fcustom-fields-checkbox-22_18jllsh.png?alt=media)

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Custom Fields Overview</strong></td><td>Learn field types, scopes, and how to manage custom fields.</td><td><a href="/platform/custom-fields/custom-fields.md">Custom Fields Overview</a></td></tr><tr><td><strong>Single-Select Field</strong></td><td>Let customers pick one option from a dropdown list.</td><td><a href="/platform/custom-fields/single-select-field.md">Single-Select Field</a></td></tr><tr><td><strong>Basket Settings</strong></td><td>Configure the Basket form, including which fields customers see.</td><td><a href="/commerce-and-integrations/mimeeq-basket/basket-settings.md">Basket Settings</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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 following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/platform/custom-fields/checkbox-field.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.