> ## 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.

# NSFormEntity

> Definition and configuration of a Form.

Definition and configuration of a Form.

## Constructors

### NSFormEntity()

```crmscript theme={null}
NSFormEntity
```

Initializes a new instance of the NSFormEntity class.

## Methods

## GetActive()

Indicates if this form is active or not

```crmscript theme={null}
Bool GetActive()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Bool active = thing.GetActive();
```

## GetConfig()

```crmscript theme={null}
String GetConfig()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The JSON-formatted config of this form.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String config = thing.GetConfig();
```

## GetDescription()

```crmscript theme={null}
String GetDescription()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Detailed description.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String description = thing.GetDescription();
```

## GetExpires()

```crmscript theme={null}
DateTime GetExpires()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - After this, the form will become inactive.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
DateTime expires = thing.GetExpires();
```

## GetFolderId()

```crmscript theme={null}
Integer GetFolderId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The folder which this form belongs to. -1 indicates that the shipment is on the root.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer folderId = thing.GetFolderId();
```

## GetFolderName()

```crmscript theme={null}
String GetFolderName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the folder for this form.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String folderName = thing.GetFolderName();
```

## GetFormId()

```crmscript theme={null}
Integer GetFormId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer formId = thing.GetFormId();
```

## GetFormKey()

```crmscript theme={null}
String GetFormKey()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - A short string used as unique ID to access this form.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String formKey = thing.GetFormKey();
```

## GetGroupId()

```crmscript theme={null}
Integer GetGroupId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The group which this form belongs to.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer groupId = thing.GetGroupId();
```

## GetMaxSubmits()

```crmscript theme={null}
Integer GetMaxSubmits()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - After this number of submits, the form will become inactive.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer maxSubmits = thing.GetMaxSubmits();
```

## GetName()

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of this form.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String name = thing.GetName();
```

## GetNewTicket()

```crmscript theme={null}
Bool GetNewTicket()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Indicates if this form creates a ticket or not.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Bool newTicket = thing.GetNewTicket();
```

## GetRecaptchaMode()

```crmscript theme={null}
Integer GetRecaptchaMode()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - What is the state of the reCAPTCHA configuration? This is a read-only member. See \<xref href="CRMScript.NetServer.FormsRecaptchaMode" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer recaptchaMode = thing.GetRecaptchaMode();
```

## GetRecipe()

```crmscript theme={null}
String GetRecipe()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The JSON-formatted recipe of this form.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String recipe = thing.GetRecipe();
```

## GetRegistered()

```crmscript theme={null}
DateTime GetRegistered()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Registered when.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
DateTime registered = thing.GetRegistered();
```

## GetRegisteredAssociateId()

```crmscript theme={null}
Integer GetRegisteredAssociateId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Registered by whom.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer registeredAssociateId = thing.GetRegisteredAssociateId();
```

## GetResponseShipmentId()

```crmscript theme={null}
Integer GetResponseShipmentId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The ID of the s\_shipment that is used to send the response mails.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer responseShipmentId = thing.GetResponseShipmentId();
```

## GetScriptId()

```crmscript theme={null}
Integer GetScriptId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The CRMScript Macro that will be run when the form is submitted.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer scriptId = thing.GetScriptId();
```

## GetType()

```crmscript theme={null}
Integer GetType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - What kind of form is this? Indicates if this is a normal form or a template. See \<xref href="CRMScript.NetServer.FormType" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer type = thing.GetType();
```

## GetUpdated()

```crmscript theme={null}
DateTime GetUpdated()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Last updated when.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
DateTime updated = thing.GetUpdated();
```

## GetUpdatedAssociateId()

```crmscript theme={null}
Integer GetUpdatedAssociateId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Last updated by whom.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer updatedAssociateId = thing.GetUpdatedAssociateId();
```

## GetUpdatedCount()

```crmscript theme={null}
Integer GetUpdatedCount()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Number of updates made to this record.

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer updatedCount = thing.GetUpdatedCount();
```

## SetActive(Bool)

```crmscript theme={null}
Void SetActive(Bool active)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Bool active;
thing.SetActive(active);
```

## SetConfig(String)

```crmscript theme={null}
Void SetConfig(String config)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String config;
thing.SetConfig(config);
```

## SetDescription(String)

```crmscript theme={null}
Void SetDescription(String description)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String description;
thing.SetDescription(description);
```

## SetExpires(DateTime)

```crmscript theme={null}
Void SetExpires(DateTime expires)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
DateTime expires;
thing.SetExpires(expires);
```

## SetFolderId(Integer)

```crmscript theme={null}
Void SetFolderId(Integer folderId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer folderId;
thing.SetFolderId(folderId);
```

## SetFolderName(String)

```crmscript theme={null}
Void SetFolderName(String folderName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String folderName;
thing.SetFolderName(folderName);
```

## SetFormId(Integer)

```crmscript theme={null}
Void SetFormId(Integer formId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer formId;
thing.SetFormId(formId);
```

## SetFormKey(String)

```crmscript theme={null}
Void SetFormKey(String formKey)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String formKey;
thing.SetFormKey(formKey);
```

## SetGroupId(Integer)

```crmscript theme={null}
Void SetGroupId(Integer groupId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer groupId;
thing.SetGroupId(groupId);
```

## SetMaxSubmits(Integer)

```crmscript theme={null}
Void SetMaxSubmits(Integer maxSubmits)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer maxSubmits;
thing.SetMaxSubmits(maxSubmits);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String name;
thing.SetName(name);
```

## SetNewTicket(Bool)

```crmscript theme={null}
Void SetNewTicket(Bool newTicket)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Bool newTicket;
thing.SetNewTicket(newTicket);
```

## SetRecaptchaMode(Integer)

```crmscript theme={null}
Void SetRecaptchaMode(Integer recaptchaMode)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer recaptchaMode;
thing.SetRecaptchaMode(recaptchaMode);
```

## SetRecipe(String)

```crmscript theme={null}
Void SetRecipe(String recipe)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
String recipe;
thing.SetRecipe(recipe);
```

## SetRegistered(DateTime)

```crmscript theme={null}
Void SetRegistered(DateTime registered)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
DateTime registered;
thing.SetRegistered(registered);
```

## SetRegisteredAssociateId(Integer)

```crmscript theme={null}
Void SetRegisteredAssociateId(Integer registeredAssociateId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer registeredAssociateId;
thing.SetRegisteredAssociateId(registeredAssociateId);
```

## SetResponseShipmentId(Integer)

```crmscript theme={null}
Void SetResponseShipmentId(Integer responseShipmentId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer responseShipmentId;
thing.SetResponseShipmentId(responseShipmentId);
```

## SetScriptId(Integer)

```crmscript theme={null}
Void SetScriptId(Integer scriptId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer scriptId;
thing.SetScriptId(scriptId);
```

## SetType(Integer)

```crmscript theme={null}
Void SetType(Integer type)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer type = 0;
thing.SetType(type);
```

## SetUpdated(DateTime)

```crmscript theme={null}
Void SetUpdated(DateTime updated)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
DateTime updated;
thing.SetUpdated(updated);
```

## SetUpdatedAssociateId(Integer)

```crmscript theme={null}
Void SetUpdatedAssociateId(Integer updatedAssociateId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer updatedAssociateId;
thing.SetUpdatedAssociateId(updatedAssociateId);
```

## SetUpdatedCount(Integer)

```crmscript theme={null}
Void SetUpdatedCount(Integer updatedCount)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFormEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);
```


## Related topics

- [NSMarketingAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSMarketingAgent.md)
- [Delete Form Entity](/en/api/reference/restful/agent/marketing_agent/delete-form-entity.md)
- [Save Form Entity](/en/api/reference/restful/agent/marketing_agent/save-form-entity.md)
- [Get Form Entity](/en/api/reference/restful/agent/marketing_agent/get-form-entity.md)
- [NSFormSubmissionEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSFormSubmissionEntity.md)
- [Delete Form Submission Entity](/en/api/reference/restful/agent/marketing_agent/delete-form-submission-entity.md)