> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetoform.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Form settings

> Manage thank-you pages, emails, access, availability, tracking, templates, and theme for a form.

These commands change how one form behaves after it is published. Every command takes the form's UUID. For fields and response details, see the API reference for [thank-you pages](https://apidocs.neetoform.com/api/thank-you-pages/list.md), [form settings](https://apidocs.neetoform.com/api/form-settings/show-access-control.md), [message templates](https://apidocs.neetoform.com/api/message-templates/list.md) and [applying a theme](https://apidocs.neetoform.com/api/themes/apply.md).

Commands named `update` change only the fields you pass. A flag you leave out is not sent. Bool flags are sent only when you set them, so use `--enabled=false` to turn something off.

## Thank-you pages

### List thank-you pages

This command lists the pages shown after someone submits the form. Use this to find a page ID.

```bash theme={"system"}
neetoform forms thank-you-pages list 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |

### Show a thank-you page

This command shows one thank-you page.

```bash theme={"system"}
neetoform forms thank-you-pages show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 0b3c5a52-7a0e-4f2b-9d57-3d6a1a2f9c11 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<id>` - The thank-you page's UUID, from `neetoform forms thank-you-pages list <form-id>`

### Create a thank-you page

This command adds a thank-you page that shows a message or sends the person to another URL.

```bash theme={"system"}
neetoform forms thank-you-pages create 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 \
  --title Pricing \
  --kind redirect_to_url \
  --redirect-url https://example.com/pricing \
  --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--description` | `string` | | | Page description |
| `--kind` | `string` | | | custom\_message or redirect\_to\_url |
| `--message` | `string` | | | HTML message shown for custom\_message |
| `--pass-event-details` | `bool` | | `false` | Pass submission details to the redirect URL |
| `--primary` | `bool` | | `false` | Make this the primary thank-you page |
| `--redirect-message` | `string` | | | HTML message shown before redirecting |
| `--redirect-url` | `string` | | | http(s) URL to redirect to; needed for redirect\_to\_url |
| `--resubmit-link-text` | `string` | | | Text of the resubmit link; needed with --show-resubmit-link |
| `--show-redirect-message` | `bool` | | `false` | Show a message before redirecting |
| `--show-resubmit-link` | `bool` | | `false` | Show a link to submit another response |
| `--social-sharing` | `bool` | | `false` | Show social sharing buttons |
| `--title` | `string` | | | Page title |

`--kind custom_message` needs `--message`. `--kind redirect_to_url` needs `--redirect-url`. `--show-resubmit-link` needs `--resubmit-link-text`. Pass `--primary` to make this the primary page; the page that was primary stops being primary.

### Update a thank-you page

This command changes a thank-you page. Only the flags you pass change.

```bash theme={"system"}
neetoform forms thank-you-pages update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 0b3c5a52-7a0e-4f2b-9d57-3d6a1a2f9c11 \
  --title "Thanks for your feedback" \
  --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<id>` - The thank-you page's UUID, from `neetoform forms thank-you-pages list <form-id>`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--description` | `string` | | | Page description |
| `--kind` | `string` | | | custom\_message or redirect\_to\_url |
| `--message` | `string` | | | HTML message shown for custom\_message |
| `--pass-event-details` | `bool` | | `false` | Pass submission details to the redirect URL |
| `--primary` | `bool` | | `false` | Make this the primary thank-you page |
| `--redirect-message` | `string` | | | HTML message shown before redirecting |
| `--redirect-url` | `string` | | | http(s) URL to redirect to; needed for redirect\_to\_url |
| `--resubmit-link-text` | `string` | | | Text of the resubmit link; needed with --show-resubmit-link |
| `--show-redirect-message` | `bool` | | `false` | Show a message before redirecting |
| `--show-resubmit-link` | `bool` | | `false` | Show a link to submit another response |
| `--social-sharing` | `bool` | | `false` | Show social sharing buttons |
| `--title` | `string` | | | Page title |

### Delete a thank-you page

This command deletes a thank-you page. It runs at once and asks no question.

```bash theme={"system"}
neetoform forms thank-you-pages delete 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 0b3c5a52-7a0e-4f2b-9d57-3d6a1a2f9c11
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<id>` - The thank-you page's UUID, from `neetoform forms thank-you-pages list <form-id>`

```text Sample output theme={"system"}
Thank-you page deleted.
```

## Email notifications

### Show email notifications

This command shows the email sent to the form's admins (`admin`) or to the person who submitted (`respondent`).

```bash theme={"system"}
neetoform forms email-notifications show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 admin --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<kind>` - `admin` or `respondent`

```json Sample output (--json) theme={"system"}
{
  "data": {
    "email_notification": {
      "kind": "admin",
      "is_enabled": true,
      "subject": "New submission",
      "notify_emails": ["oliver@example.com"],
      "notify_cc_emails": [],
      "notify_bcc_emails": [],
      "message": "<div>Someone submitted</div>",
      "reply_to_question_id": null,
      "reply_to": null,
      "send_to_question_id": null
    }
  }
}
```

### Update email notifications

This command changes the admin or respondent email. Use this to turn the email on or off, change its text, or change who gets it.

```bash theme={"system"}
neetoform forms email-notifications update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 admin \
  --enabled=true \
  --to oliver@example.com,sam@example.com \
  --subject "New submission" \
  --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<kind>` - `admin` or `respondent`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--bcc` | `string` | | | Comma-separated admin BCC emails |
| `--cc` | `string` | | | Comma-separated admin CC emails |
| `--enabled` | `bool` | | `false` | Send this email after a submission |
| `--message` | `string` | | | HTML email body |
| `--reply-to` | `string` | | | Reply-to email address; respondent only |
| `--reply-to-question-id` | `string` | | | UUID of the email question used as reply-to; admin only |
| `--send-to-question-id` | `string` | | | UUID of the email question whose answer receives the email; respondent only |
| `--subject` | `string` | | | Email subject |
| `--to` | `string` | | | Comma-separated admin recipient emails |

`--to`, `--cc` and `--bcc` are comma-separated lists and replace the current list. `--reply-to-question-id` works on `admin` only. `--reply-to` and `--send-to-question-id` work on `respondent` only.

## Submission rules

### Show unique submission

This command shows how the form stops the same person from submitting twice.

```bash theme={"system"}
neetoform forms unique-submission show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

### Update unique submission

This command sets how repeat submissions are blocked.

```bash theme={"system"}
neetoform forms unique-submission update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --method cookie_track --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--method` | `string` | Yes | | How duplicate submissions are prevented: no\_track, cookie\_track, ip\_track or record\_track |
| `--question-id` | `string` | | | UUID of the email or phone question that identifies a respondent; used with record\_track |

`--method` is one of `no_track` (allow repeats), `cookie_track`, `ip_track` or `record_track`. With `record_track`, pass `--question-id` with the UUID of an email or phone question.

### Show availability

This command shows when the form accepts submissions and whether it is open now.

```bash theme={"system"}
neetoform forms availability show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

```json Sample output (--json) theme={"system"}
{
  "data": {
    "availability": {
      "manage_access_method": "based_on_limit_and_time",
      "submission_deadline": "2030-01-01T00:00:00.000Z",
      "submission_limit": 50,
      "custom_closed_message": "This form is closed.",
      "is_enabled": true
    }
  }
}
```

### Update availability

This command opens or closes the form, or sets a deadline or a submission limit.

```bash theme={"system"}
neetoform forms availability update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 \
  --method based_on_limit_and_time \
  --deadline 2030-01-01T00:00:00Z \
  --limit 50 \
  --closed-message "This form is closed." \
  --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--closed-message` | `string` | | | Message shown when the form is closed |
| `--deadline` | `string` | | | Stop accepting submissions at this ISO 8601 date-time, e.g. 2030-01-01T00:00:00Z |
| `--limit` | `int` | | `0` | Stop accepting submissions after this many (1 to 1000000) |
| `--method` | `string` | | | enable, disable, based\_on\_submission\_count, based\_on\_time or based\_on\_limit\_and\_time |

`--method` is one of `enable`, `disable`, `based_on_submission_count`, `based_on_time` or `based_on_limit_and_time`. `--deadline` is an ISO 8601 date-time. `--limit` is from 1 to 1000000.

## Access control

### Show access control

This command shows who can open the form. The password is never returned; `has_password` tells you if one is set.

```bash theme={"system"}
neetoform forms access-control show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

```json Sample output (--json) theme={"system"}
{
  "data": {
    "access_control": {
      "auth": "basic",
      "has_password": true,
      "allowed_keywords": [],
      "invitations_count": 0
    }
  }
}
```

### Update access control

This command sets who can open the form.

```bash theme={"system"}
neetoform forms access-control update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --auth basic --password s3cret-pass --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--allowed-keywords` | `string` | | | Comma-separated allowed emails or domains for email access |
| `--auth` | `string` | Yes | | no, basic (password), email (allowed email keywords), session (login) or invited |
| `--password` | `string` | | | Password for basic access, at least 4 characters |

`--auth` is one of `no` (anyone), `basic` (password), `email` (allowed emails or domains), `session` (login) or `invited` (invited emails only). `basic` needs `--password` of at least 4 characters. `email` uses `--allowed-keywords`, a comma-separated list of emails or domains.

### List invited emails

This command lists the emails invited to a form whose access is `invited`.

```bash theme={"system"}
neetoform forms access-control-invitations list 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |

### Invite emails

This command adds emails to the invited list. Set the form's access to `invited` first with `access-control update --auth invited`.

```bash theme={"system"}
neetoform forms access-control-invitations create 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --emails oliver@example.com,sam@example.com --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--emails` | `string` | Yes | | Comma-separated emails to invite, 1 to 100. The form access must be set to invited |

You can pass 1 to 100 emails in one call.

### Remove invited emails

This command removes emails from the invited list. They can no longer open the form.

```bash theme={"system"}
neetoform forms access-control-invitations delete 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --emails sam@example.com --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--emails` | `string` | Yes | | Comma-separated emails to remove, 1 to 100 |

You can pass 1 to 100 emails in one call.

## Discount codes, tracking, and chat

### List discount codes

This command lists the workspace's discount codes and shows in `enabled` whether this form accepts each one.

```bash theme={"system"}
neetoform forms discount-codes list 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |

### Update discount codes

This command replaces the list of discount codes the form accepts.

```bash theme={"system"}
neetoform forms discount-codes update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --ids 1f2e5a52-7a0e-4f2b-9d57-3d6a1a2f9c11 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--ids` | `string` | Yes | | Comma-separated UUIDs of the discount codes the form accepts; pass an empty value to clear all |

The list you pass replaces the old one. Run it without `--ids` and the form accepts no code.

### Show tracking codes

This command shows the Google Analytics, Google Tag Manager, and Meta Pixel IDs set on the form.

```bash theme={"system"}
neetoform forms tracking-codes show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

### Update tracking codes

This command sets or removes the tracking IDs.

```bash theme={"system"}
neetoform forms tracking-codes update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --google-analytics G-ABC123XYZ --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--google-analytics` | `string` | | | Google Analytics ID, G-... or UA-...; pass an empty value to remove |
| `--google-tag-manager` | `string` | | | Google Tag Manager ID, GTM-...; pass an empty value to remove |
| `--meta-pixel` | `string` | | | Meta Pixel ID, 15 or 16 digits; pass an empty value to remove |

Pass an empty value, for example `--meta-pixel ""`, to remove an ID.

### Show NeetoChat

This command shows whether the NeetoChat widget appears on the public form.

```bash theme={"system"}
neetoform forms neeto-chat show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

### Update NeetoChat

This command shows or hides the NeetoChat widget on the public form.

```bash theme={"system"}
neetoform forms neeto-chat update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --enabled=true --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--enabled` | `bool` | Yes | `false` | Show the NeetoChat widget on the public form: --enabled=true or --enabled=false |

## Message templates

### List message templates

This command lists the form's email and SMS templates. Use `--type` and `--status` to narrow the list.

```bash theme={"system"}
neetoform forms message-templates list 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --type email --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |
| `--status` | `string` | | | Only templates with this status: active or inactive |
| `--type` | `string` | | | Only templates of this type: email or sms |

### Show a message template

This command shows one template.

```bash theme={"system"}
neetoform forms message-templates show 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 4a9d1c20-6b3e-4f58-8d71-2c5e9b0a7f34 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<id>` - The message template's UUID, from `neetoform forms message-templates list <form-id>`

### Create a message template

This command adds an email or SMS template.

```bash theme={"system"}
neetoform forms message-templates create 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 \
  --name "Thank you" \
  --type email \
  --subject "Thanks for your response" \
  --body "<p>We got your response.</p>" \
  --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--body` | `string` | Yes | | Template body; HTML for email |
| `--name` | `string` | Yes | | Template name |
| `--status` | `string` | | | active or inactive |
| `--subject` | `string` | | | Email subject; needed for email templates |
| `--type` | `string` | Yes | | email or sms |

`--subject` is needed for `email` templates. `--body` is HTML for `email` templates.

### Update a message template

This command changes a template. The type cannot change.

```bash theme={"system"}
neetoform forms message-templates update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 4a9d1c20-6b3e-4f58-8d71-2c5e9b0a7f34 --status inactive --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<id>` - The message template's UUID, from `neetoform forms message-templates list <form-id>`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--body` | `string` | | | Template body; HTML for email |
| `--name` | `string` | | | Template name |
| `--status` | `string` | | | active or inactive |
| `--subject` | `string` | | | Email subject |

### Delete a message template

This command deletes a template. It runs at once and asks no question.

```bash theme={"system"}
neetoform forms message-templates delete 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 4a9d1c20-6b3e-4f58-8d71-2c5e9b0a7f34
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`
* `<id>` - The message template's UUID, from `neetoform forms message-templates list <form-id>`

```text Sample output theme={"system"}
Message template deleted.
```

## Theme

### Apply a theme

This command applies a system theme or one of your workspace themes to a form. Find theme IDs with `neetoform themes list`.

```bash theme={"system"}
neetoform forms theme update 7db4b04a-6e17-4af6-a1d6-650c4cba3f91 --theme-id 9e2b7d14-3c58-4a61-b0f9-5d8c1e6a2f73 --json
```

**Required arguments:**

* `<form-id>` - The form's UUID, from `neetoform forms list`

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--theme-id` | `string` | Yes | | ID of the system or workspace theme to apply |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.