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

# form table

> A form which can be published on a webpage and submitted by visitors

## form Table (488)

A form which can be published on a webpage and submitted by visitors

## Fields

| Name                      | Description                                                                          | Type                                            | Nullable |
| ------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------- | :------: |
| form\_id                  | Primary key                                                                          | PK                                              |    No    |
| name                      | The name of this form                                                                | String(4000)                                    |    Yes   |
| description               | Detailed description                                                                 | String(4000)                                    |    Yes   |
| config                    | The JSON-formatted config of this form                                               | Clob                                            |    Yes   |
| folder\_id                | The folder which this form belongs to. -1 indicates that the shipment is on the root | FK [s\_picture\_folder](./s-picture-folder.mdx) |    No    |
| script\_id                | The CRMScript Macro which will be run when the form is submitted.                    | FK [ejscript](./ejscript.mdx)                   |    No    |
| response\_shipment\_id    | The id of the s\_shipment that is used to send the response mails                    | FK [s\_shipment](./s-shipment.mdx)              |    No    |
| registered                | Registered when                                                                      | UtcDateTime                                     |    No    |
| registered\_associate\_id | Registered by whom                                                                   | FK [associate](./associate.mdx)                 |    No    |
| updated                   | Last updated when                                                                    | UtcDateTime                                     |    No    |
| updated\_associate\_id    | Last updated by whom                                                                 | FK [associate](./associate.mdx)                 |    No    |
| updatedCount              | Number of updates made to this record                                                | UShort                                          |    No    |
| active                    | Indicates if this form is active and available for customers                         | Bool                                            |    Yes   |
| expires                   | After this datetime, the form will become inactive                                   | DateTime                                        |    Yes   |
| maxSubmits                | After this number of submits, the form will become inactive                          | Int                                             |    Yes   |
| type                      | What kind of form is this? Indicates if this is a normal form or a template          | Enum [FormType](./enums/formtype.mdx)           |    No    |
| recipe                    | The JSON-formatted recipe of this form                                               | Clob                                            |    Yes   |
| group\_id                 | The group which this form belongs to.                                                | FK [UserGroup](./usergroup.mdx)                 |    No    |
| form\_key                 | A short string used as unique id to access this form                                 | String(32)                                      |    Yes   |
| new\_ticket               | True if this form creates a new ticket                                               | Bool                                            |    Yes   |

<img src="https://mintcdn.com/superofficeas/6OcOTPa_ISkjXJg4/media/loc/en/database/tables/form.png?fit=max&auto=format&n=6OcOTPa_ISkjXJg4&q=85&s=2eab27e1d0d7fe2b9a7fdeca3d512d94" alt="form table relationship diagram" width="899" height="782" data-path="media/loc/en/database/tables/form.png" />

## Indexes

| Fields                 | Types      | Description |
| ---------------------- | ---------- | ----------- |
| script\_id             | FK         | Index       |
| response\_shipment\_id | FK         | Index       |
| form\_key              | String(32) | Index       |

## Relationships

| Table                                                   | Description                                                                     |
| ------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [associate](./associate)                                | Employees, resources and other users - except for External persons              |
| [ejscript](./ejscript)                                  | ejscript                                                                        |
| [email\_flow\_content\_link](./email-flow-content-link) | Links content to an email workflow                                              |
| [form\_submission](./form-submission)                   | A form submission                                                               |
| [person](./person)                                      | Persons                                                                         |
| [s\_link](./s-link)                                     | Links in messages to measure success rate of a campaign.                        |
| [s\_picture\_folder](./s-picture-folder)                | This table contains all picture folders                                         |
| [s\_shipment](./s-shipment)                             | Contains info about one shipment. The addresses are stored in s\_shipment\_addr |
| [UserGroup](./usergroup)                                | Secondary user groups                                                           |

## Replication Flags

* None

## Security Flags

* No access control via user's Role.


## Related topics

- [Forms](/en/api/archive-providers/reference/forms.md)
- [FormsAndFolders](/en/api/archive-providers/reference/formsandfolders.md)
- [Create a new form](/en/marketing/forms/learn/create.md)
- [form_submission table](/en/database/tables/form-submission.md)
- [form_keys table](/en/database/tables/form-keys.md)
- [form_field_restriction table](/en/database/tables/form-field-restriction.md)
